ts_json_api 0.2.0 → 0.2.1

data/README.md

@@ -27,6 +27,7 @@ TsJsonApi::Configure.setup do |config|
 	config.api_version = 2
 	config.logging_enabled = true
 	config.server_url = ""
+	config.timestamped_logs = false
 end
 ```
 
@@ -34,6 +35,14 @@ The `username`, `password`, and `server_url` fields are all requried to specify
 
 You can disable logging by setting `logging_enabled = false`. Logging will log the raw response from the T&S service into the Rails `tmp/ts_json_api/` directory for you to review.
 
+If you wish to keep a log file for every transaction with the API, you will want to enabled `timestamped_logs`.  This feature will keep a unique file instead of overwriting the previous response from the API every time.
+
+If you use this feature, we highly encourage you to run the included rake task:
+
+```shell
+> bundle exec rake ts_json_api:remove_old_log_files
+```
+
 ## Usage
 
 This gem exposes several methods that map directly to API calls from the T&S team.  

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

@@ -10,6 +10,7 @@ TsJsonApi::Configure.setup do |config|
 	config.api_version = 2
 	config.logging_enabled = true
 	config.server_url = ""
+	config.timestamped_logs = false
 end
 			CONFIG
 		end

data/lib/tasks/ts_json_api_tasks.rake

@@ -1,4 +1,14 @@
-# desc "Explaining what the task does"
-# task :ts_json_api do
-#   # Task goes here
-# end
+namespace :ts_json_api do
+	
+	desc "will remove timestamped log files older than 24 hours"
+	desc remove_old_log_files: :environment do
+		old_timestamp = 1.day.ago.to_i
+		Dir["#{TsJsonApi::Configure::LOG_FILE_DIRECTORY}/**/*.log"].each do |file|
+			if file =~ /_t(\d+)\.log$/
+				file_timestamp = Time.at($1.to_i)
+				File.delete file if file_timestamp < old_timestamp
+			end
+		end
+	end
+
+end

data/lib/ts_json_api/configure.rb

@@ -1,10 +1,15 @@
 module TsJsonApi
   class Configure
+
+    LOG_FILE_DIRECTORY = Rails.root.join('log', 'ts_json_api')
+
     class << self
 
-      attr_accessor :api_version, :logging_enabled
+      attr_accessor :api_version, :logging_enabled, :timestamped_logs
       attr_writer :username, :password, :server_url
+
       alias_method :logging_enabled?, :logging_enabled
+      alias_method :timestamped_logs?, :timestamped_logs
       
       def username
       	raise "Must provide an username" if @username.blank?
@@ -29,6 +34,7 @@ module TsJsonApi
 
     @api_version = 2
     @logging_enabled = true
+    @timestamped_logs = false
 
   end
 end

data/lib/ts_json_api/requestor/drivers.rb

@@ -7,13 +7,13 @@ module TsJsonApi
 			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}"
+					send_json_request_and_deliver_response "#{race_season}/#{series_id}/drivers", "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
+					send_json_request_and_deliver_response "#{race_season}/#{series_id}/#{driver_id}-summary", url
 				end
 
 			end

data/lib/ts_json_api/requestor/live_feed.rb

@@ -6,15 +6,15 @@ module TsJsonApi
 			module ClassMethods
 
 				def live_feed
-					send_json_request_and_deliver_response :live_feed, "livefeed"
+					send_json_request_and_deliver_response "live/live_feed", "livefeed"
 				end
 
 				def live_flag
-					send_json_request_and_deliver_response :live_flag, "liveflag"
+					send_json_request_and_deliver_response "live/live_flag", "liveflag"
 				end
 
 				def live_points
-					send_json_request_and_deliver_response :live_points, "livepoints"
+					send_json_request_and_deliver_response "live/live_points", "livepoints"
 				end
 
 			end

data/lib/ts_json_api/requestor/logging.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module TsJsonApi
 	class Requestor
 		module Logging
@@ -6,16 +8,23 @@ module TsJsonApi
 
 			module ClassMethods
 
-				def log(type, url, str)
+				def log(path, 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}"}
+
+					if Configure.timestamped_logs?
+						path << "_t#{Time.now.to_i}.log"
+					else
+						path << ".log"
+					end
+
+					create_dir_if_not_exists File.dirname(path)
+					File.open(Configure::LOG_FILE_DIRECTORY.join(path), '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)
+					def create_dir_if_not_exists(path="")
+						dir = Configure::LOG_FILE_DIRECTORY.join path
+						FileUtils.mkpath dir unless Dir.exists?(dir)
 					end
 
 			end

data/lib/ts_json_api/requestor/points.rb

@@ -8,14 +8,14 @@ module TsJsonApi
 				def points_per_race(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}"
+					path = "#{race_season}/#{series_id}/points"
 
 					unless race_id.blank?
 						url << "&race_id=#{race_id}"
-						file_type << "_race_#{race_id}"
+						path.gsub! "points.log", "#{race_id}-points"
 					end
 
-					send_json_request_and_deliver_response file_type, url
+					send_json_request_and_deliver_response path, url
 
 				end
 

data/lib/ts_json_api/requestor/private_methods.rb

@@ -6,14 +6,14 @@ module TsJsonApi
 
 			module ClassMethods
 
-				def send_json_request_and_deliver_response(file_type, partial_url)
+				def send_json_request_and_deliver_response(path, partial_url)
 					url = "#{Configure.server_url}#{partial_url}"
 
 				  response = perfom_request(partial_url)
 					json = response.to_str
 					json.gsub!(/[^\x20-\x7e]/,'')
 
-					log(file_type, url, json)
+					log(path, url, json)
 
 					JSON.parse(json)
 			  end

data/lib/ts_json_api/requestor/races.rb

@@ -7,13 +7,14 @@ module TsJsonApi
 			module ClassMethods
 
 				def get_race(race_id)
-					send_json_request_and_deliver_response "race_info_#{race_id}", "races/#{race_id}"
+					send_json_request_and_deliver_response "races/#{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
+					path = driver_id.nil? ? "schedule" : "#{driver_id}-races"
+					send_json_request_and_deliver_response "#{race_season}/#{series_id}/#{path}", url
 				end
 
 			end

data/lib/ts_json_api/requestor/schedule.rb

@@ -6,11 +6,11 @@ module TsJsonApi
 			module ClassMethods
 
 				def schedule_for_race(race_id)
-					send_json_request_and_deliver_response "schedule_for_race_#{race_id}", "weekendschedule/#{race_id}"
+					send_json_request_and_deliver_response "races/#{race_id}-schedule", "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}"
+					send_json_request_and_deliver_response "#{race_season}/#{series_id}/schedule", "weekendschedule/?race_season=#{race_season}&series_id=#{series_id}"
 				end
 
 			end

data/lib/ts_json_api/requestor/series.rb

@@ -5,7 +5,7 @@ module TsJsonApi
 			extend ActiveSupport::Concern
 			module ClassMethods
 				def series
-					send_json_request_and_deliver_response :series, "series"
+					send_json_request_and_deliver_response "series", "series"
 				end
 			end
 

data/lib/ts_json_api/requestor/tracks.rb

@@ -9,13 +9,13 @@ module TsJsonApi
 
 					if series_id.blank?
 						url = "track/#{track_id}"
-						file_type = "track_info_#{track_id}"
+						path = "tracks/#{track_id}"
 					else
 						url = "track/?track_id=#{track_id}&series_id=#{series_id}"
-						file_type = "track_info_#{track_id}_series_#{series_id}"
+						path = "tracks/#{series_id}/#{track_id}"
 					end
 
-					send_json_request_and_deliver_response file_type, url
+					send_json_request_and_deliver_response path, url
 				end
 
 			end

data/lib/ts_json_api/requestor/weekend.rb

@@ -6,7 +6,7 @@ module TsJsonApi
 			module ClassMethods
 
 				def weekend(race_id)
-					send_json_request_and_deliver_response "weekend_#{race_id}", "weekend/#{race_id}"
+					send_json_request_and_deliver_response "races/#{race_id}-weekend", "weekend/#{race_id}"
 				end
 
 			end

data/lib/ts_json_api/version.rb

@@ -1,3 +1,3 @@
 module TsJsonApi
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ts_json_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -117,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3004862939807243004
+      hash: -1078779843776586039
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3004862939807243004
+      hash: -1078779843776586039
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24