CricApi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6aabd14ad812f282db2de9aa4926f481be1409d
-  data.tar.gz: eeedd5d736fc4d4255dd21909407bafc0d747c11
+  metadata.gz: 1b5210a5a0bf710137e733a7766af2fa428eb4f5
+  data.tar.gz: 04ae472b8b1def21c59bbe832af6d8f4b992ab57
 SHA512:
-  metadata.gz: 7dd60df6a3eb72885fc6b1ea0529724888a1d5ef83945582dc488c759ecef6dd0a7e57bdd781deaad9d7c21084ff3e4ed9c990e5630b62af43f96d7f76d0b544
-  data.tar.gz: 7a268f5ebdec90d0efe4139ecf7ca12afadeec187bedb8b219afbea1c32dbe49aa6406fe3206568e963e1bd8097f81b5e2dc60e398c5bb4c0f9f6edfbb888fb3
+  metadata.gz: 5aabdeb2931194ba2bef3bb70a60226cad3016bddc38ea23583e9072535b265941f7d5be7b9ae1f7bb6aa572f715dfdb9dca9602113035100435c2369304a42f
+  data.tar.gz: 4aa5061cb1bff89c1087ef02e52988e06c33403a99c66ce8be2b80dc15021cc8271008a77588ec51d2098aa87deb60998c3ff9ee7a167d4deb717a8c29aba5c2

data/CricApi.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{This is a ruby wrapper to access cricapi.com live cricket data}
   spec.description   = %q{This is a ruby wrapper to access cricapi.com live cricket data}
   spec.homepage      = "https://github.com/KarthikGangadhar/CricApi"
-  spec.license       = "MIT"
+  spec.license       = ""
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    CricApi (0.1.0)
+    CricApi (0.2.0)
       hashie
       httparty
 

data/README.md

@@ -22,7 +22,122 @@ Or install it yourself as:
 
 ## Usage
 
-Write usage instructions here
+The [CricApi](http://www.cricapi.com/), Free to use, super-high bandwidth, high performance Cricket API. Targeted at Developers and Cricket lovers.
+
+
+In order to use the [CricApi](http://www.cricapi.com/) endpoints, u need to have an api_key which can use generated by signing into [cricapi](http://www.cricapi.com/). For testing purpose can use test_api_key "TESTKEY0273"
+
+There are five endpoint, Usage is as Follow
+
+```ruby
+    require 'CricApi'
+    
+    api_key = "TESTKEY0273"
+    cricapi = CricApi::Request.new(api_key)
+```
+cricket endpoint, Old Match API 
+
+```ruby 
+   
+    cricapi.cricket
+    # => {
+  			"ttl": 2,
+  			"v": "1",
+  			"cache": true,
+  			"data": [
+    					{
+      						"unique_id": "1122751",
+      						"description": "Mid West Rhinos 213/6 * v Mashonaland Eagles 321/10 ",
+      						"title": "Mid West Rhinos 213/6 * v Mashonaland Eagles 321/10 "
+    					}
+    			    ]
+    	 }
+```
+schedule endpoint, Match Calender 
+    	 
+```ruby
+
+    cricapi.schedule
+    # => { 			
+  			"data": [
+    					{
+      						"unique_id": "will generate 1-2 days before match",
+      						"name": "India v Sri Lanka at Kolkata, 1st Test - day 1",
+      					"date": "16 November 2017"
+    					},
+    					{
+      						"unique_id": "will generate 1-2 days before match",
+      						"name": "India v Sri Lanka at Kolkata, 1st Test - day 2",
+      						"date": "17 November 2017"
+    					}
+    			    ]		
+    	 }    	 	    
+```
+
+cricketScore endpoint, This requires a match unique_id, which will be provide by cricket endpoint 
+    	 
+```ruby
+
+	unique_id = "1034809"
+    cricapi.cricketScore(unique_id)
+    # => {
+  			"matchStarted": true,
+  			"team-1": "England",
+  			"team-2": "India",
+  			"cache": true,
+  			"v": "1",
+  			"ttl": 2,
+  			"provider": {
+    			"source": "Various",
+    			"url": "https://cricapi.com/",
+    			"pubDate": "2017-11-11T06:24:19.712Z"
+  			},
+		}   	 	    
+```
+
+matches endpoint, This requires a match unique_id, which will be provide by cricket endpoint 
+    	 
+```ruby
+    cricapi.matches
+    # => {
+  			"matches": [
+    						{
+      							"unique_id": 1124063,
+      							"date": "2017-11-10T00:00:00.000Z",
+      							"team-2": "Band-e-Amir Region",
+      							"team-1": "Mis Ainak Region",
+      							"type": "First-class",
+      							"dateTimeGMT": "2017-11-07T04:30:00.000Z",
+      							"squad": true,
+      							"toss_winner_team": "Band-e-Amir Region",
+      							"matchStarted": true
+    						} 
+    				   ]
+           }				    	 	    
+```
+
+playerStats endpoint, This requires a players pid, which will be obtained [here](http://www.cricapi.com/players/) 
+    	 
+```ruby
+
+	pid = "32350"
+    cricapi.playerStats(unique_id)
+    # => {
+  			"pid": 35320,
+  			"profile": "\n\nSachin Tendulkar has been the most complete batsman of his time, the most prolific runmaker of all time, and arguably the biggest cricket icon the game has ever known. His batting was based on the purest principles: perfect balance, economy of movement, precision in stroke-making, and that intangible quality given only to geniuses - anticipation. If he didn't have a signature stroke - the upright, back-foot punch comes close - it's because he was equally proficient at each of the full range of orthodox shots (and plenty of improvised ones as well) and can pull them out at will.  \n\n",
+ 			"imageURL": "http://cricapi.com/playerpic/35320.jpg",
+  			"battingStyle": "Right-hand bat",
+  			"bowlingStyle": "Right-arm offbreak, Legbreak googly",
+  			"majorTeams": "India,Asia XI,Mumbai,Mumbai Indians,Yorkshire",
+  			"currentAge": "44 years 186 days",
+  			"born": "April 24, 1973, Bombay (now Mumbai), Maharashtra",
+  			"fullName": "Sachin Ramesh Tendulkar",
+  			"name": "Sachin Tendulkar",
+  			"country": "India",
+  			"playingRole": "Top-order batsman"
+  		}
+  		 	 	    
+```
 
 ## Development
 
@@ -32,12 +147,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/CricApi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/karthikgangadhar/CricApi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the CricApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/CricApi/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the CricApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[karthikgangadhar]/CricApi/blob/master/CODE_OF_CONDUCT.md).

data/lib/CricApi.rb

@@ -1,30 +1,54 @@
 require "CricApi/version"
-require "CricApi/helper/request"
+require "hashie"
+require "httparty"
 
 module CricApi
+  class Request
+  include HTTParty
+  base_uri 'http://cricapi.com'
   
-  def self.cricket
-    Cricket::Request.new('https://apecricket.herokuapp.com', 0).cricket
+  def initialize(key)
+    @options = { query: {site: "cricapi.com", apikey: key }  }
+  end
+  
+  def cricket
+    response = self.class.get("/api/cricket", @options)
+    cricket = clean_response(response)
+    cricket
   end
 
-  def self.matches
-    Cricket::Request.new('https://apecricket.herokuapp.com', 0).matches
+  def matches
+    response = self.class.get("/api/matches", @options)
+    matches = clean_response(response)
+    matches    
   end
   
-  def self.schedule
-    Cricket::Request.new('https://apecricket.herokuapp.com', 0).matchCalendar
+  def schedule
+    response = self.class.get("/api/matchCalendar", @options)
+    schedule = clean_response(response)
+    schedule
   end
   
-  def self.cricketScore(id)
-    Cricket::Request.new('https://apecricket.herokuapp.com', 0).cricketScore(id)
+  def cricketScore(id)
+    @options[:query][:unique_id] = id
+    response = self.class.post("/api/cricketScore", @options)
+    cricketScore = clean_response(response)
+    cricketScore
   end
   
-  def self.playerStats(pid)
-    Cricket::Request.new('https://apecricket.herokuapp.com', 0).playerStats(pid)
+  def playerStats(pid)
+    @options[:query][:pid] = pid
+    response = self.class.post("/api/playerStats", @options)
+    playerStats = clean_response(response)
+    playerStats
   end
   
-  def self.score(id)
-    Cricket::Request.new('https://apecricket.herokuapp.com', 0).playerStats(id)
+  private
+  
+  def clean_response(response)
+    is_response_present = (response.empty? && response.nil? && response.parsed_response.empty? && response.parsed_response.nil?)
+    is_response_present ? Hashie::Mash.new({ :error => "No data"}) : Hashie::Mash.new( response.parsed_response )
   end
   
 end
+end

data/lib/CricApi/version.rb

@@ -1,3 +1,3 @@
 module CricApi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: CricApi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - kgangadhar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-10 00:00:00.000000000 Z
+date: 2017-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -100,13 +100,12 @@ files:
 - bin/console
 - bin/setup
 - lib/CricApi.rb
-- lib/CricApi/helper/request.rb
 - lib/CricApi/version.rb
 - tasks/debug.rake
 - tasks/rspec.rake
 homepage: https://github.com/KarthikGangadhar/CricApi
 licenses:
-- MIT
+- ''
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/lib/CricApi/helper/request.rb

@@ -1,78 +0,0 @@
-require 'httparty'
-require 'json'
-
-module Cricket
-  class Request
-    include HTTParty
-    base_uri 'https://apecricket.herokuapp.com'
-    
-    def initialize(service, page)
-      @options = { query: {site: service, page: page} }
-    end
-
-    def cricket
-      self.class.get("/api/cricket", @options)
-    end
-
-    def matches
-      self.class.get("/api/matches", @options)
-    end
-
-    def matchCalendar
-      self.class.get("/api/matchCalendar", @options)
-    end
-
-    def getNews
-      self.class.get("/api/news", @options)
-    end
-
-    def cricketScore(id)
-      self.class.post("/api/cricketScore",
-      :body => {
-        :unique_id => id
-      }
-      )
-    end
-
-    def playerStats(id)
-      self.class.post("/api/playerStats",
-      :body => {
-        :pid => id
-      }
-      )
-    end
-
-    def ballByball(id)
-      self.class.post("/api/ballByBall",
-      :body => {
-        :unique_id => id
-      }
-      )
-    end
-
-    def commentry(id)
-      self.class.post("/api/commentry",
-      :body => {
-        :unique_id => id
-      }
-      )
-    end
-
-    def news(id)
-      self.class.post("/api/news",
-      :body => {
-        :unique_id => id
-      }
-      )
-    end
-
-    def score(id)
-      self.class.post("/api/score",
-      :body => {
-        :unique_id => id
-      }
-      )
-    end
-
-end
-end