ts_json_api 0.0.1 → 0.1.0

data/README.md

@@ -1,3 +1,59 @@
 # Timing and Scoring JSON API
 
-Use this gem to consume the T&S JSON API provided for live & summary race data.
+Use this gem to consume the T&S JSON API provided for live & summary race data.
+
+## Installation
+
+Run the following rails generator to setup the gem
+
+	> rails g ts_json_api:install
+
+This generator creates an initializer that you will need to configure for your access token to use the API.
+
+## Usage
+
+This gem exposes several methods that map directly to API calls from the T&S team.  
+
+### Syntax
+
+You are offered two ways to initiate calls. The first is shorthand for the second.
+
+```ruby
+TsJsonApi.weekend 4080
+TsJsonApi::Requestor.weekend 4080
+```
+
+### Examples
+Example calls follow:
+
+```ruby
+
+# Drivers
+TsJsonApi.get_drivers(year, series_id)
+TsJsonApi.driver_summary(race_season, series_id, driver_id=nil)
+
+# Live Feed
+TsJsonApi.live_feed
+TsJsonApi.live_flag
+TsJsonApi.live_points
+
+# Points
+TsJsonApi.driver_points(race_season, series_id, race_id=nil)
+
+# Races
+TsJsonApi.get_race(race_id)
+TsJsonApi.races_in_season(race_season, series_id, driver_id=nil)
+
+# Schedule
+TsJsonApi.schedule_for_race(race_id)
+TsJsonApi.schedule_for_season(race_season, series_id)
+
+# Series
+TsJsonApi.series
+
+# Tracks
+TsJsonApi.get_track(track_id, series_id=nil)
+
+# Weekend
+TsJsonApi.weekend(race_id)
+```

data/lib/generators/ts_json_api/install/install_generator.rb

@@ -0,0 +1,17 @@
+module TsJsonApi
+	class InstallGenerator < Rails::Generators::Base
+		source_root File.expand_path("../templates", __FILE__)
+
+		def create_initializer
+			initializer "ts_json_api.rb", <<-CONFIG
+TsJsonApi::Configure.setup do |config|
+	config.username = ""
+	config.password = ""
+	config.logging_enabled = true
+	config.server_url = ""
+end
+			CONFIG
+		end
+
+	end
+end

data/lib/ts_json_api/configure.rb

@@ -0,0 +1,46 @@
+module TsJsonApi
+  class Configure
+    class << self
+      
+      def username=(u)
+        @@username = u
+      end
+      
+      def username
+      	raise "Must provide an username" if @@username.blank?
+        @@username
+      end
+
+      def password=(p)
+        @@password = p
+      end
+
+      def password
+        raise "Must provide a password" if @@password.blank?
+        @@password
+      end
+
+      def server_url=(s)
+        @@server_url = s
+      end
+
+      def server_url
+        raise "Must provide a server URL for the API" if @@server_url.blank?
+        @@server_url
+      end
+
+      def logging_enabled=(b)
+        @@logging_enabled = b
+      end
+
+      def logging_enabled?
+        @@logging_enabled ||= true
+      end
+      
+      def setup(&block)
+        block.call(self)
+      end
+      
+    end
+  end
+end

data/lib/ts_json_api/requestor/drivers.rb

@@ -0,0 +1,23 @@
+module TsJsonApi
+	class Requestor
+		module Drivers
+
+			extend ActiveSupport::Concern
+
+			module ClassMethods
+
+				def get_drivers(race_season, series_id)
+					send_json_request_and_deliver_response "drivers_#{race_season}_series_#{series_id}", "driver?race_season=#{race_season}&series_id=#{series_id}"
+				end
+
+				def driver_summary(race_season, series_id, driver_id=nil)
+					url = "driversummary?race_season=#{race_season}&series_id=#{series_id}"
+					url << "&driver_id=#{driver_id}" unless driver_id.blank?
+					send_json_request_and_deliver_response "driver_summary_#{race_season}_#{series_id}_#{driver_id}", url
+				end
+
+			end
+
+		end
+	end
+end

data/lib/ts_json_api/requestor/live_feed.rb

@@ -0,0 +1,24 @@
+module TsJsonApi
+	class Requestor
+		module LiveFeed
+
+			extend ActiveSupport::Concern
+			module ClassMethods
+
+				def live_feed
+					send_json_request_and_deliver_response :live_feed, "livefeed"
+				end
+
+				def live_flag
+					send_json_request_and_deliver_response :live_flag, "liveflag"
+				end
+
+				def live_points
+					send_json_request_and_deliver_response :live_points, "livepoints"
+				end
+
+			end
+
+		end
+	end
+end

data/lib/ts_json_api/requestor/logging.rb

@@ -0,0 +1,25 @@
+module TsJsonApi
+	class Requestor
+		module Logging
+
+			extend ActiveSupport::Concern
+
+			module ClassMethods
+
+				def log(type, url, str)
+					return unless Configure.logging_enabled?
+					create_dir_if_not_exists
+					File.open("#{Rails.root}/log/ts_json_api/#{type}.log", 'w') { |f| f.write "[TIME]: #{Time.now}\n[URL]: #{url}\n\n#{str}"}
+				end
+
+				private
+					def create_dir_if_not_exists
+						dir = "#{Rails.root}/log/ts_json_api"
+						Dir.mkdir dir unless Dir.exists?(dir)
+					end
+
+			end
+
+		end
+	end
+end

data/lib/ts_json_api/requestor/points.rb

@@ -0,0 +1,26 @@
+module TsJsonApi
+	class Requestor
+		module Points
+
+			extend ActiveSupport::Concern
+			module ClassMethods
+
+				def driver_points(race_season, series_id, race_id=nil)
+
+					url = "driverpoints?race_season=#{race_season}&series_id=#{series_id}"
+					file_type = "driver_points_#{race_season}_series_#{series_id}"
+
+					unless race_id.blank?
+						url << "&race_id=#{race_id}"
+						file_type << "_race_#{race_id}"
+					end
+
+					send_json_request_and_deliver_response file_type, url
+
+				end
+
+			end
+
+		end
+	end
+end

data/lib/ts_json_api/requestor/private_methods.rb

@@ -0,0 +1,54 @@
+module TsJsonApi
+	class Requestor
+		module PrivateMethods
+
+			extend ActiveSupport::Concern
+
+			module ClassMethods
+
+				def send_json_request_and_deliver_response(file_type, partial_url, &block)
+					failure = false
+					reason = nil
+					begin
+				    
+						url = "#{Configure.server_url}#{partial_url}"
+
+				    response = api[partial_url].get accept: :json
+					  json = response.to_str
+					  json.gsub!(/[^\x20-\x7e]/,'')
+
+					  self.log file_type, url, json
+
+					  json = JSON.parse(json)
+
+					  if json.is_a?(Hash) && json.keys.include?('ResponseCode') && json['ResponseCode'].to_i != 200
+							failure = true
+							reason = "JSON feed failure with a response code: #{json['ResponseCode']}"
+					  end
+					rescue RestClient::ResourceNotFound => e
+					  failure = true
+					  reason = "NASCAR JSON Unavailable"
+					rescue ActiveRecord::RecordInvalid => e
+					  failure = true
+					  reason = "NASCAR JSON Data prevented a database save as it did not meet validation requirements"
+					end
+					return block.call(failure, json, reason) if block_given?
+					json
+			  end
+			  
+			  def default_processor_block
+					@block ||= lambda do |failure, json, reason| 
+					  Rails.logger.error "block status: #{failure} -- reason: '#{reason}'"
+					  failure ? nil : json
+					end
+			  end
+
+			  def api
+					@@api ||= RestClient::Resource.new(Configure.server_url, user: Configure.username, password: Configure.password, timeout: 20)
+			  end
+
+			end
+
+		end
+	end
+end

data/lib/ts_json_api/requestor/races.rb

@@ -0,0 +1,23 @@
+module TsJsonApi
+	class Requestor
+		module Races
+
+			extend ActiveSupport::Concern
+
+			module ClassMethods
+
+				def get_race(race_id)
+					send_json_request_and_deliver_response "race_info_#{race_id}", "races/#{race_id}"
+				end
+
+				def races_in_season(race_season, series_id, driver_id=nil)
+					url = "races?race_season=#{race_season}&series_id=#{series_id}"
+					url << "&driver_id=#{driver_id}" unless driver_id.blank?
+					send_json_request_and_deliver_response "races_#{race_season}_#{series_id}_#{driver_id}", url
+				end
+
+			end
+
+		end
+	end
+end

data/lib/ts_json_api/requestor/schedule.rb

@@ -0,0 +1,20 @@
+module TsJsonApi
+	class Requestor
+		module Schedule
+
+			extend ActiveSupport::Concern
+			module ClassMethods
+
+				def schedule_for_race(race_id)
+					send_json_request_and_deliver_response "schedule_for_race_#{race_id}", "weekendschedule/#{race_id}"
+				end
+
+				def schedule_for_season(race_season, series_id)
+					send_json_request_and_deliver_response "schedule_for_season_#{race_season}_series_#{series_id}", "weekendschedule/?race_season=#{race_season}&series_id=#{series_id}"
+				end
+
+			end
+
+		end
+	end
+end

data/lib/ts_json_api/requestor/series.rb

@@ -0,0 +1,14 @@
+module TsJsonApi
+	class Requestor
+		module Series
+
+			extend ActiveSupport::Concern
+			module ClassMethods
+				def series
+					send_json_request_and_deliver_response :series, "series"
+				end
+			end
+
+		end
+	end
+end

data/lib/ts_json_api/requestor/tracks.rb

@@ -0,0 +1,25 @@
+module TsJsonApi
+	class Requestor
+		module Tracks
+
+			extend ActiveSupport::Concern
+			module ClassMethods
+
+				def get_track(track_id, series_id=nil)
+
+					if series_id.blank?
+						url = "track/#{track_id}"
+						file_type = "track_info_#{track_id}"
+					else
+						url = "track/?track_id=#{track_id}&series_id=#{series_id}"
+						file_type = "track_info_#{track_id}_series_#{series_id}"
+					end
+
+					send_json_request_and_deliver_response file_type, url
+				end
+
+			end
+
+		end
+	end
+end

data/lib/ts_json_api/requestor/utility_methods.rb

@@ -0,0 +1,17 @@
+module TsJsonApi
+	class Requestor
+		module UtilityMethods
+
+			extend ActiveSupport::Concern
+
+			module ClassMethods
+
+				def parse_date(str)
+					Time.zone.at str.scan(/[0-9]+/)[0].to_i
+				end
+
+			end
+
+		end
+	end
+end

data/lib/ts_json_api/requestor/weekend.rb

@@ -0,0 +1,16 @@
+module TsJsonApi
+	class Requestor
+		module Weekend
+
+			extend ActiveSupport::Concern
+			module ClassMethods
+
+				def weekend(race_id)
+					send_json_request_and_deliver_response "weekend_#{race_id}", "weekend/#{race_id}"
+				end
+
+			end
+
+		end
+	end
+end

data/lib/ts_json_api/requestor.rb

@@ -0,0 +1,30 @@
+require 'ts_json_api/requestor/private_methods'
+require 'ts_json_api/requestor/drivers'
+require 'ts_json_api/requestor/live_feed'
+require 'ts_json_api/requestor/logging'
+require 'ts_json_api/requestor/points'
+require 'ts_json_api/requestor/races'
+require 'ts_json_api/requestor/schedule'
+require 'ts_json_api/requestor/series'
+require 'ts_json_api/requestor/tracks'
+require 'ts_json_api/requestor/utility_methods'
+require 'ts_json_api/requestor/weekend'
+
+module TsJsonApi
+	class Requestor
+
+		include PrivateMethods
+		include Logging
+		include UtilityMethods
+
+		include Drivers
+		include LiveFeed
+		include Points
+		include Races
+		include Schedule
+		include Series
+		include Tracks
+		include Weekend
+
+	end
+end

data/lib/ts_json_api/version.rb

@@ -1,3 +1,3 @@
 module TsJsonApi
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/ts_json_api.rb

@@ -1,2 +1,31 @@
+require 'rest-client'
+
 module TsJsonApi
-end
+
+	autoload :Configure,			'ts_json_api/configure'
+	autoload :Requestor,			'ts_json_api/requestor'
+
+	# Expose all the methods of the Requestor class directly on the module itself
+	#
+	# Example call:
+	# 	TsJsonApi.weekend 
+	# 	is same as
+	# 	TsJsonApi::Requestor.weekend
+	#
+	class << self
+
+		def method_missing(method, *args, &block)
+			if Requestor.respond_to?(method)
+				Requestor.send method, *args
+			else
+				super
+			end
+		end
+
+		def respond_to?(method)
+			Requestor.respond_to? method
+		end 
+
+	end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ts_json_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +66,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/generators/ts_json_api/install/install_generator.rb
 - lib/tasks/ts_json_api_tasks.rake
+- lib/ts_json_api/configure.rb
+- lib/ts_json_api/requestor/drivers.rb
+- lib/ts_json_api/requestor/live_feed.rb
+- lib/ts_json_api/requestor/logging.rb
+- lib/ts_json_api/requestor/points.rb
+- lib/ts_json_api/requestor/private_methods.rb
+- lib/ts_json_api/requestor/races.rb
+- lib/ts_json_api/requestor/schedule.rb
+- lib/ts_json_api/requestor/series.rb
+- lib/ts_json_api/requestor/tracks.rb
+- lib/ts_json_api/requestor/utility_methods.rb
+- lib/ts_json_api/requestor/weekend.rb
+- lib/ts_json_api/requestor.rb
 - lib/ts_json_api/version.rb
 - lib/ts_json_api.rb
 - MIT-LICENSE
@@ -100,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1839472513994288648
+      hash: 4083627172601262233
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -109,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1839472513994288648
+      hash: 4083627172601262233
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24