{"id":22819543,"url":"https://github.com/dcalixto/punching_bag","last_synced_at":"2025-10-27T15:46:08.079Z","repository":{"id":265577087,"uuid":"896284368","full_name":"dcalixto/punching_bag","owner":"dcalixto","description":"A Crystal shard for tracking and analyzing hit counts, trending items, and time-based analytics.","archived":false,"fork":false,"pushed_at":"2024-12-17T20:52:49.000Z","size":2481,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-06T04:41:26.801Z","etag":null,"topics":["counter","crystal","crystal-lang","hitcounter","shard","tracking"],"latest_commit_sha":null,"homepage":"https://github.com/dcalixto/punching_bag","language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dcalixto.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-30T00:40:08.000Z","updated_at":"2024-12-17T20:52:53.000Z","dependencies_parsed_at":"2025-02-06T04:38:13.844Z","dependency_job_id":"ac70d3d2-7300-43bb-945a-d851ec635356","html_url":"https://github.com/dcalixto/punching_bag","commit_stats":null,"previous_names":["dcalixto/punching_bag"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcalixto%2Fpunching_bag","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcalixto%2Fpunching_bag/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcalixto%2Fpunching_bag/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcalixto%2Fpunching_bag/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dcalixto","download_url":"https://codeload.github.com/dcalixto/punching_bag/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246390872,"owners_count":20769478,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["counter","crystal","crystal-lang","hitcounter","shard","tracking"],"created_at":"2024-12-12T15:12:51.201Z","updated_at":"2025-10-27T15:46:03.030Z","avatar_url":"https://github.com/dcalixto.png","language":"Crystal","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Punching Bag\n\n![Punch Bag](./src/punching-bag.gif)\n\nA Crystal shard for tracking and analyzing hit counts, trending items, time and location analytics for PostgreSQL.\n\n[![Crystal Test](https://github.com/dcalixto/punching_bag/actions/workflows/crystal-test.yml/badge.svg?branch=master)](https://github.com/dcalixto/punching_bag/actions/workflows/crystal-test.yml)\n\n## Features\n\n- Timezone-aware tracking using PostgreSQL's TIMESTAMPTZ\n- Location-based analytics support\n- Configurable hit counting\n- Time-based popularity tracking\n- Efficient indexing for fast queries\n- Lightweight and fast\n\n## Requirements\n\n- Crystal \u003e= 1.0.0\n\n## Installation\n\n1. Add Punching Bag to your `shard.yml`:\n\n```yaml\ndependencies:\n  punching_bag:\n    github: dcalixto/punching_bag\n```\n\n2. Install dependencies:\n\n```crystal\nshards install\n```\n\n3. Run the setup command:\n\n```crystal\ncrystal run bin/micrate.cr -- up\n```\n\nIf the setup has already been completed, you will see the following message in your terminal:\n\n```crystal\nSetup already completed.\n```\n\n## Usage\n\nImport the library\n\n```crystal\nrequire \"punching_bag\"\n```\n\n**_Then in your application code, you can set it up like:_**\n\nInitialize database connection\n\n```crystal\nPunchingBag.configure do |config|\n  config.database_url = \"postgres://localhost/your_database\"\nend\n```\n\n## Initialize the tracker\n\n```crystal\n# Initialize tracker\ntracker = PunchingBag::Tracker.new(PunchingBag.db)\n```\n\nRecord a hit\n\n```crystal\ntracker.punch(\"Article\", 1)\n```\n\nTrack hits with custom timestamp and timezone\n\n```crystal\ntimestamp = Time.local(timezone: Time::Location.load(\"America/New_York\"))\ntracker.punch(\"Article\", 1, hits: 1, timestamp: timestamp)\n```\n\nRecord multiple hits\n\n```crystal\ntracker.punch(\"Article\", 1, hits: 5)\n```\n\nRecord hit with timestamp\n\n```crystal\ntracker.punch(\"Article\", 1, timestamp: Time.utc - 1.day)\n```\n\n## Analytics\n\nGet total hits for an item\n\n```crystal\ntotal = tracker.total_hits(\"Article\", 1)\n```\n\nGet most hit items since last week\n\n```crystal\ntrending = tracker.most_hit(Time.utc - 1.week)\n```\n\nGet top 10 most hit items since last month\n\n```crystal\ntop_items = tracker.most_hit(Time.utc - 1.month, limit: 10)\n```\n\nGet average time for hits\n\n```crystal\navg_time = tracker.average_time(\"Article\", 1)\n```\n\nClear all recorded hits\n\n```crystal\ntracker.clear\n```\n\n## Example Integration\n\nHere’s an example of integrating Punching Bag into an application.\n\n```crystal\nrequire \"punching_bag\"\nrequire \"db/serializable\"\n\nclass Article\n include DB::Serializable\n\n   property id : Int64\n   property title : String\n\n  def self.db=(database : DB::Database)\n    @@db = database\n  end\n\n  def self.db\n    @@db.not_nil!\n  end\n\n  def track_view\n    tracker = PunchingBag.new(@@db.not_nil!)\n    tracker.punch(\"Article\", id.not_nil!)\n  end\n\n  def total_views\n    tracker = PunchingBag.new(@@db.not_nil!)\n    tracker.total_hits(\"Article\", id.not_nil!)\n  end\n\n  def self.trending(since = Time.utc - 1.week, limit = 10)\n    tracker = PunchingBag.new(@@db.not_nil!)\n    tracker.most_hit(since, limit: limit)\n  end\nend\n\n```\n\nThe Routes\n\n```crystal\nget \"/articles/:id\" do |env|\n  if article = Article.find(env.params.url[\"id\"].to_i64)\n    article.track_view\n    render \"article/show.ecr\"\n  else\n    env.redirect \"/articles\"\n  end\nend\n```\n\nView\n\nTo display the total view count in your view, use the following HTML:\n\n```crystal\n\u003cdiv class=\"views-count\"\u003e\n  Views: \u003c%= article.total_views %\u003e\n\u003c/div\u003e\n```\n\n## Development\n\n```crystal\ncrystal spec\n```\n\n## Contributing\n\n1. Fork it (https://github.com/dcalixto/punching_bag/fork)\n2. Create your feature branch (`git checkout -b my-feature`)\n3. Commit your changes (`git commit -am 'Add feature'`)\n4. Push to the branch (`git push origin my-feature`)\n5. Create a new Pull Request\n\n## Contributors\n\nDaniel Calixto - creator and maintainer\n\n## License\n\nMIT License. See LICENSE for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcalixto%2Fpunching_bag","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdcalixto%2Fpunching_bag","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcalixto%2Fpunching_bag/lists"}