celly 0.1.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: defce80b6f8f4835435a0d6dbf86396bc2184be90cc9eca21466e1229e71c73f
-  data.tar.gz: ddb9321d54da80e9c20374c6f0aca77056f5bef29079da8ebb689dc48b22cf30
+  metadata.gz: 85c078dd92911270d18417d6d8e4c30482f3a7ada4189e01482574b07f267501
+  data.tar.gz: 9f9ff41762eaab28c9651f62ac4b61a4ea4f09144c0cc8a9077a7040fd8efb54
 SHA512:
-  metadata.gz: f5f2ea335dab3c69ed9cf66f40c4750d29c34e766ad0a518e379760037b7728a2bb2d2561f9d699bb6a17eedab16a4549c095f2230475bbd7719428d18ce54c2
-  data.tar.gz: 17a921d58951fd77dc36cc8014a10ed64066e62cc56ca214aeeacdc5dbca9327cc98214e412ee0b24cac7b47c31298d946ae05ddb923d0d98176e88e94479b3c
+  metadata.gz: 046b403f0d08c73215f08bba3839ca1ff98b7e086c5b5783fc25686e10ea42243d19a5b8007db8aedfa6e82681e82a80b448f0bee3d76d61272a5aa3bcaebc5b
+  data.tar.gz: 3d809c5445078eea86ecc05aad72f46085f4ddd4a5e4dee6ec7967492f91c5bacb9b72c9e95bbec8055c800a112ff0dc8d7305f0f83ba2981b23df4f0ce883fb

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## Celly 0.1.2 (Feb. 23, 2021)
+* Added Schedule all and team methods
+* Added Standings overall method
+* Added Team find method
+* Added tests for all new methods
+
+## Celly 0.5.0 (Feb. 26, 2021)
+* Added Leaders (goals, assists, points, etc.)
+* Added Scores (today, yesterday, by date)

data/README.md

@@ -1,14 +1,14 @@
-# Celly
+![kane-celly](https://user-images.githubusercontent.com/8561395/109370958-90721d00-7870-11eb-9ae5-ee0bd881fc3d.gif)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/celly`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Celly
 
-TODO: Delete this and the text above, and describe your gem
+Celly is a Ruby wrapper for the NHL Stats API, a little-known, undocumented API maintained by the National Hockey League. Celly aims to provide an easy-to-use DSL for making requests to the NHL Stats API and retrieving data about Teams, Players, Schedules, and Standings.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
+```bash
 gem 'celly'
 ```
 
@@ -22,7 +22,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Celly has six classes (as of now)—Player, Leaders, Scores, Team, Standings, and Schedule. Using the gem is a simple as instantiating a class and calling the available methods:
+
+Get a player's profile:
+```bash
+irb(main):002:0> player = Celly::Player.new
+=> #<Celly::Player:0x000000011db23776>
+
+irb(main):003:0> player.profile(8478402)
+=> {:status=>"200", :message=>"OK", :data=>[{"id"=>8478402, "fullName"=>"Connor McDavid", "link"=>"/api/v1/people/8478402", "firstName"=>"Connor", "lastName"=>"McDavid", "primaryNumber"=>"97", "birthDate"=>"1997-01-13", "currentAge"=>24, "birthCity"=>"Richmond Hill", "birthStateProvince"=>"ON", "birthCountry"=>"CAN", "nationality"=>"CAN", "height"=>"6' 1\"", "weight"=>193, "active"=>true, "alternateCaptain"=>false, "captain"=>true, "rookie"=>false, "shootsCatches"=>"L", "rosterStatus"=>"Y", "currentTeam"=>{"id"=>22, "name"=>"Edmonton Oilers", "link"=>"/api/v1/teams/22"}, "primaryPosition"=>{"code"=>"C", "name"=>"Center", "type"=>"Forward", "abbreviation"=>"C"}}]}
+```
+
+Get a team's stats:
+
+```bash
+irb(main):004:0> team = Celly::Team.new
+=> #<Celly::Team:0x000000011dc25123>
+
+irb(main):005:0> team.stats(7)
+=> {:status=>"200", :message=>"OK", :data=>[{"type"=>{"displayName"=>"statsSingleSeason", "gameType"=>{"id"=>"R", "description"=>"Regular season", "postseason"=>false}}, "splits"=>[{"stat"=>{"gamesPlayed"=>15, "wins"=>5, "losses"=>8, "ot"=>2, "pts"=>12, "ptPctg"=>"40.0", "goalsPerGame"=>2.333, "goalsAgainstPerGame"=>3.0, "evGGARatio"=>0.6, "powerPlayPercentage"=>"32.6", "powerPlayGoals"=>16.0, "powerPlayGoalsAgainst"=>8.0, "powerPlayOpportunities"=>49.0, "penaltyKillPercentage"=>"75.8", "shotsPerGame"=>30.0667, "shotsAllowed"=>28.5333, "winScoreFirst"=>0.6, "winOppScoreFirst"=>0.2, "winLeadFirstPer"=>0.667, "winLeadSecondPer"=>1.0, "winOutshootOpp"=>0.429, "winOutshotByOpp"=>0.25, "faceOffsTaken"=>833.0, "faceOffsWon"=>450.0, "faceOffsLost"=>383.0, "faceOffWinPercentage"=>"54.0", "shootingPctg"=>7.8, "savePctg"=>0.895}, "team"=>{"id"=>7, "name"=>"Buffalo Sabres", "link"=>"/api/v1/teams/7"}}]}, {"type"=>{"displayName"=>"regularSeasonStatRankings", "gameType"=>nil}, "splits"=>[{"stat"=>{"wins"=>"30th", "losses"=>"25th", "ot"=>"20th", "pts"=>"30th", "ptPctg"=>"28th", "goalsPerGame"=>"28th", "goalsAgainstPerGame"=>"21st", "evGGARatio"=>"30th", "powerPlayPercentage"=>"4th", "powerPlayGoals"=>"8th", "powerPlayGoalsAgainst"=>"8th", "powerPlayOpportunities"=>"26th", "penaltyKillOpportunities"=>"1st", "penaltyKillPercentage"=>"23rd", "shotsPerGame"=>"16th", "shotsAllowed"=>"8th", "winScoreFirst"=>"30th", "winOppScoreFirst"=>"25th", "winLeadFirstPer"=>"23rd", "winLeadSecondPer"=>"13th", "winOutshootOpp"=>"24th", "winOutshotByOpp"=>"24th", "faceOffsTaken"=>"28th", "faceOffsWon"=>"22nd", "faceOffsLost"=>"2nd", "faceOffWinPercentage"=>"2nd", "savePctRank"=>"24th", "shootingPctRank"=>"26th"}, "team"=>{"id"=>7, "name"=>"Buffalo Sabres", "link"=>"/api/v1/teams/7"}}]}]}
+```
+
+Want today's scores?
+
+```bash
+irb(main):006:0> scores = Celly::Scores.new
+  => #<Celly::Scores:0x000000011db23776>
+
+irb(main):007:0> scores.today
+=> {:status=>"200", :message=>"OK", :data=>[{"date"=>"2021-02-26", "totalItems"=>1, "totalEvents"=>0, "totalGames"=>3, "totalMatches"=>0, "games"=>[{"gamePk"=>2020020323, "link"=>"/api/v1/game/2020020323/feed/live", "gameType"=>"R", "season"=>"20202021", "gameDate"=>"2021-02-27T00:00:00Z", "status"=>{"abstractGameState"=>"Live", "codedGameState"=>"3", "detailedState"=>"In Progress", "statusCode"=>"3", "startTimeTBD"=>false}, "teams"=>{"away"=>{"leagueRecord"=>{"wins"=>11, "losses"=>4, "ot"=>2, "type"=>"league"}, "score"=>0, "team"=>{"id"=>6, "name"=>"Boston Bruins", "link"=>"/api/v1/teams/6"}}, "home"=>{"leagueRecord"=>{"wins"=>6, "losses"=>8, "ot"=>3, "type"=>"league"}, "score"=>0, "team"=>{"id"=>3, "name"=>"New York Rangers", "link"=>"/api/v1/teams/3"}}}, "venue"=>{"id"=>5054, "name"=>"Madison Square Garden", "link"=>"/api/v1/venues/5054"}, "content"=>{"link"=>"/api/v1/game/2020020323/content"}}], "events"=>[], "matches"=>[]}]}
+```
+
+Get the current scoring leaders:
+
+```bash
+irb(main):005:0> leaders = Celly::Leaders.new
+=> #<Celly::Leaders:0x000000013b6913b0>
+
+irb(main):006:0> leaders.points(20202021)
+=> {:status=>"200", :message=>"OK", :data=>[{"leaderCategory"=>"points", "depth"=>"singleSeason", "playerStatus"=>"allPlayers", "season"=>"2020-2021", "gameType"=>{"id"=>"R", "description"=>"Regular season", "postseason"=>false}, "limitMetadata"=>{"limit"=>5, "offset"=>0, "additionalTies"=>0}, "leaders"=>[{"rank"=>1, "value"=>"40", "team"=>{"id"=>22, "name"=>"Edmonton Oilers", "link"=>"/api/v1/teams/22"}, "person"=>{"id"=>8478402, "fullName"=>"Connor McDavid", "link"=>"/api/v1/people/8478402"}}, {"rank"=>2, "value"=>"34", "team"=>{"id"=>22, "name"=>"Edmonton Oilers", "link"=>"/api/v1/teams/22"}, "person"=>{"id"=>8477934, "fullName"=>"Leon Draisaitl", "link"=>"/api/v1/people/8477934"}}, {"rank"=>3, "value"=>"31", "team"=>{"id"=>10, "name"=>"Toronto Maple Leafs", "link"=>"/api/v1/teams/10"}, "person"=>{"id"=>8479318, "fullName"=>"Auston Matthews", "link"=>"/api/v1/people/8479318"}}, {"rank"=>3, "value"=>"31", "team"=>{"id"=>16, "name"=>"Chicago Blackhawks", "link"=>"/api/v1/teams/16"}, "person"=>{"id"=>8474141, "fullName"=>"Patrick Kane", "link"=>"/api/v1/people/8474141"}}, {"rank"=>5, "value"=>"30", "team"=>{"id"=>10, "name"=>"Toronto Maple Leafs", "link"=>"/api/v1/teams/10"}, "person"=>{"id"=>8478483, "fullName"=>"Mitchell Marner", "link"=>"/api/v1/people/8478483"}}]}]}
+```
 
 ## Development
 
@@ -30,9 +69,13 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Testing
+
+Celly uses RSpec for testing. To run the tests, run `bundle exec rspec` 
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/celly.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rymcmahon/celly.
 
 
 ## License

data/celly.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/rymcmahon/celly"
-  spec.metadata["changelog_uri"] = "https://github.com/rymcmahon/celly/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/rymcmahon/celly/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/celly.rb

@@ -3,6 +3,8 @@ require "celly/player"
 require "celly/team"
 require "celly/schedule"
 require "celly/standings"
+require "celly/leaders"
+require "celly/scores"
 
 module Celly
   class Error < StandardError; end

data/lib/celly/leaders.rb

@@ -0,0 +1,72 @@
+require 'net/http'
+require 'json'
+
+class Celly::Leaders
+  BASE_URL = 'https://statsapi.web.nhl.com/api/v1'
+
+  def goals(season)
+    end_point = "/stats/leaders?leaderCategories=goals&season#{season}"
+    uri = URI("#{BASE_URL}#{end_point}")
+    response = Net::HTTP.get_response(uri)
+
+    if response.code == '200'
+      json_response = JSON.parse(response.body)
+      {status: response.code, message: response.message, data: json_response["leagueLeaders"]}
+    else
+      {status: response.code, message: response.message}
+    end
+  end
+
+  def assists(season)
+    end_point = "/stats/leaders?leaderCategories=assists&season#{season}"
+    uri = URI("#{BASE_URL}#{end_point}")
+    response = Net::HTTP.get_response(uri)
+
+    if response.code == '200'
+      json_response = JSON.parse(response.body)
+      {status: response.code, message: response.message, data: json_response["leagueLeaders"]}
+    else
+      {status: response.code, message: response.message}
+    end
+  end
+
+  def points(season)
+    end_point = "/stats/leaders?leaderCategories=points&season#{season}"
+    uri = URI("#{BASE_URL}#{end_point}")
+    response = Net::HTTP.get_response(uri)
+
+    if response.code == '200'
+      json_response = JSON.parse(response.body)
+      {status: response.code, message: response.message, data: json_response["leagueLeaders"]}
+    else
+      {status: response.code, message: response.message}
+    end
+  end
+
+  def shutouts(season)
+    end_point = "/stats/leaders?leaderCategories=shutouts&season#{season}"
+    uri = URI("#{BASE_URL}#{end_point}")
+    response = Net::HTTP.get_response(uri)
+
+    if response.code == '200'
+      json_response = JSON.parse(response.body)
+      {status: response.code, message: response.message, data: json_response["leagueLeaders"]}
+    else
+      {status: response.code, message: response.message}
+    end
+
+  end
+
+  def wins(season)
+    end_point = "/stats/leaders?leaderCategories=wins&season#{season}"
+    uri = URI("#{BASE_URL}#{end_point}")
+    response = Net::HTTP.get_response(uri)
+
+    if response.code == '200'
+      json_response = JSON.parse(response.body)
+      {status: response.code, message: response.message, data: json_response["leagueLeaders"]}
+    else
+      {status: response.code, message: response.message}
+    end
+  end
+end

data/lib/celly/scores.rb

@@ -0,0 +1,48 @@
+require 'net/http'
+require 'json'
+require 'date'
+
+class Celly::Scores
+  BASE_URL = 'https://statsapi.web.nhl.com/api/v1'
+  
+  def today
+    today = Date.today.strftime("%Y-%m-%d")
+    end_point = "/schedule?startDate=#{today}&endDate=#{today}"
+    uri = URI("#{BASE_URL}#{end_point}")
+    response = Net::HTTP.get_response(uri)
+
+    if response.code == '200'
+      json_response = JSON.parse(response.body)
+      {status: response.code, message: response.message, data: json_response["dates"]}
+    else
+      {status: response.code, message: response.message}
+    end
+  end
+
+  def yesterday
+    yesterday = Date.today.prev_day.strftime("%Y-%m-%d")
+    end_point = "/schedule?startDate=#{yesterday}&endDate=#{yesterday}"
+    uri = URI("#{BASE_URL}#{end_point}")
+    response = Net::HTTP.get_response(uri)
+
+    if response.code == '200'
+      json_response = JSON.parse(response.body)
+      {status: response.code, message: response.message, data: json_response["dates"]}
+    else
+      {status: response.code, message: response.message}
+    end
+  end
+
+  def on(date)
+    end_point = "/schedule?startDate=#{date}&endDate=#{date}"
+    uri = URI("#{BASE_URL}#{end_point}")
+    response = Net::HTTP.get_response(uri)
+
+    if response.code == '200'
+      json_response = JSON.parse(response.body)
+      {status: response.code, message: response.message, data: json_response["dates"]}
+    else
+      {status: response.code, message: response.message}
+    end
+  end
+end

data/lib/celly/version.rb

@@ -1,3 +1,3 @@
 module Celly
-  VERSION = "0.1.2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: celly
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.5.0
 platform: ruby
 authors:
 - rymcmahon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-23 00:00:00.000000000 Z
+date: 2021-02-27 00:00:00.000000000 Z
 dependencies: []
 description: This gem provides an easy-to-use DSL for retrieving player and team statistics
   from the National Hockey League's API. Simple methods calls will give access to
@@ -23,6 +23,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -32,8 +33,10 @@ files:
 - bin/setup
 - celly.gemspec
 - lib/celly.rb
+- lib/celly/leaders.rb
 - lib/celly/player.rb
 - lib/celly/schedule.rb
+- lib/celly/scores.rb
 - lib/celly/standings.rb
 - lib/celly/team.rb
 - lib/celly/version.rb
@@ -44,7 +47,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/rymcmahon/celly
   source_code_uri: https://github.com/rymcmahon/celly
-  changelog_uri: https://github.com/rymcmahon/celly/CHANGELOG.md
+  changelog_uri: https://github.com/rymcmahon/celly/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: