ts_json_api 0.2.6 → 0.2.7

data/README.md

@@ -113,4 +113,27 @@ rescue TsJsonApi::AccessTokenRefused
 
 rescue TsJsonApi::Exception => e
 	puts "some exception bubbled up from RestClient: #{e}, or a catch-all for all TsJsonApi exceptions"
-```
+```
+
+### Logging
+
+There are settings mentioned above to enable logging so that the gem will log files automatically when a request is made. However, there is also a simple API to read and utilize the information stored in the log files.  For example, to get the contents of the response from the most recent `TsJsonApi.series` call that was made:
+
+```ruby
+f = TsJsonApi::Logging::File.new relative_path "series.log", readonly: true
+f.contents[:content]
+# => Hash/Array, actual JSON response made earlier
+f.contents[:time]
+# => Time object
+f.contents[:url]
+# => "http://server.url/api/series"
+```
+
+If you have the absolute path to the file:
+
+```ruby
+f = TsJsonApi::Logging::File.new path: my_path, readonly: true
+```
+
+## Testing
+The test suite is written in rpsec, so just run `rake spec` to see the status of the tests.

data/lib/ts_json_api.rb

@@ -5,6 +5,7 @@ require 'ts_json_api/railtie'
 module TsJsonApi
 
 	autoload :Configure,			'ts_json_api/configure'
+	autoload :Logging,				'ts_json_api/logging'
 	autoload :Requestor,			'ts_json_api/requestor'
 
 	# Expose all the methods of the Requestor class directly on the module itself

data/lib/ts_json_api/logging.rb

@@ -0,0 +1,5 @@
+module TsJsonApi
+  module Logging
+    autoload :File, 'ts_json_api/logging/file'
+  end
+end

data/lib/ts_json_api/logging/file.rb

@@ -0,0 +1,60 @@
+module TsJsonApi
+  module Logging
+    class File
+
+      attr_reader :path, :options
+
+      def initialize(options={})
+
+        @options = options
+        @url = options[:url]
+
+        relative_path = options[:relative_path] || ''
+        if relative_path.blank? 
+          @path = options[:path] unless options[:path].blank?
+        else
+          unless relative_path.end_with? '.log'
+
+            relative_path.gsub! ".log", ''
+            if Configure.timestamped_logs?
+              relative_path << "_t#{Time.now.to_i}.log"
+            else
+              relative_path << ".log"
+            end
+
+          end
+
+          @path = Configure::LOG_FILE_DIRECTORY.join(relative_path)
+        end
+
+        raise ArgumentError, 'need help finding a path!' if @path.blank?
+
+      end
+
+      def write(content)
+        raise 'Cannot write to log file if opened as readonly' if @options[:readonly]
+        create_dir_if_not_exists
+        ::File.open(@path, 'w') { |f| f.write content_string(content) }
+      end
+
+      def contents
+        raise 'Only available when reading a file' unless @options[:readonly]
+        json = JSON.parse(IO.read path).symbolize_keys
+        json[:content] = JSON.parse(json[:content])
+        json
+      end
+
+      private
+
+      def content_string(str)
+        { time: Time.now, url: options[:url], content: str }.to_json
+      end
+
+      def create_dir_if_not_exists
+        dir = ::File.dirname(path)
+        FileUtils.mkpath dir unless Dir.exists?(dir)
+      end
+
+    end
+  end
+end

data/lib/ts_json_api/requestor.rb

@@ -1,21 +1,17 @@
 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

data/lib/ts_json_api/requestor/private_methods.rb

@@ -45,6 +45,11 @@ module TsJsonApi
 			  	end
 			  end
 
+				def log(path, url, str)
+					f = Logging::File.new(relative_path: path, url: url)
+					f.write str
+				end
+
 			end
 
 		end

data/lib/ts_json_api/version.rb

@@ -1,3 +1,3 @@
 module TsJsonApi
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/spec/configure_spec.rb

@@ -2,61 +2,47 @@ require 'spec_helper'
 
 describe TsJsonApi::Configure do
 
-	context "Throw exceptions when values are not set" do
+  context "Throw exceptions when values are not set" do
 
-		it "should raise exception when accessing blank username" do
-			expect { TsJsonApi::Configure.username }.to raise_error(RuntimeError, "Must provide an username")
-		end
+    it "should raise exception when accessing blank username" do
+      expect { TsJsonApi::Configure.username }.to raise_error(RuntimeError, "Must provide an username")
+    end
 
-		it "should raise exception when accessing blank password" do
-			expect { TsJsonApi::Configure.password }.to raise_error(RuntimeError, "Must provide a password")
-		end
+    it "should raise exception when accessing blank password" do
+      expect { TsJsonApi::Configure.password }.to raise_error(RuntimeError, "Must provide a password")
+    end
 
-		it "should raise exception when accessing blank server_url" do
-			expect { TsJsonApi::Configure.server_url }.to raise_error(RuntimeError, "Must provide a server URL for the API")
-		end
+    it "should raise exception when accessing blank server_url" do
+      expect { TsJsonApi::Configure.server_url }.to raise_error(RuntimeError, "Must provide a server URL for the API")
+    end
 
-	end
+  end
 
-	context "store values appropriately" do
+  context "default settings" do
+    subject { TsJsonApi::Configure }
+    its(:api_version) { should == 2}
+    it { should be_logging_enabled }
+    it { should_not be_timestamped_logs }
+  end
 
-		it "should set username & return it" do
-			TsJsonApi::Configure.username = "username"
-			TsJsonApi::Configure.username.should == "username"
-		end
+  context "store values appropriately" do
 
-		it "should set password & return it" do
-			TsJsonApi::Configure.password = "password"
-			TsJsonApi::Configure.password.should == "password"
-		end
+    subject { TsJsonApi::Configure }
 
-		it "should have default API version" do
-			TsJsonApi::Configure.api_version.should == 2
-		end
+    before do
+      TsJsonApi::Configure.username = "username"
+      TsJsonApi::Configure.password = "password"
+      TsJsonApi::Configure.api_version = 1
+      TsJsonApi::Configure.logging_enabled = false
+      TsJsonApi::Configure.timestamped_logs = true
+    end
 
-		it "should store & return API version" do
-			TsJsonApi::Configure.api_version = 1
-			TsJsonApi::Configure.api_version.should == 1
-		end
+    its(:username) { should == "username" }
+    its(:password) { should == "password" }
+    its(:api_version) { should == 1 }
+    it { should_not be_logging_enabled }
+    it { should be_timestamped_logs }
 
-		it "logging should be enabled by default" do
-			TsJsonApi::Configure.logging_enabled?.should == true
-		end
+  end
 
-		it "should store logging enabled value" do
-			TsJsonApi::Configure.logging_enabled = false
-			TsJsonApi::Configure.logging_enabled?.should == false
-		end
-
-		it "should have timestamp logging disabled by default" do
-			TsJsonApi::Configure.timestamped_logs?.should be_false
-		end
-
-		it "should store timestamped logging setting" do
-			TsJsonApi::Configure.timestamped_logs = true
-			TsJsonApi::Configure.timestamped_logs?.should be_true
-		end
-
-	end
-
-end
+end

data/spec/exceptions_spec.rb

@@ -2,41 +2,36 @@ require 'spec_helper'
 
 describe TsJsonApi::Exception do
 
-	before :each do
-		@exception = TsJsonApi::Exception.new
-	end
-
-	it "should default to class name for no message" do
-		@exception.message.should == @exception.class.name
-	end
-
-	it "should store message" do
-		@exception.message = "lorem ipsum"
-		@exception.message.should == "lorem ipsum"
-	end
-
-	it "should store rest client exception" do
-		@exception.rest_client_exception.should be_nil
-		@exception.rest_client_exception = RestClient::Exception.new
-		@exception.rest_client_exception.should be_an_instance_of(RestClient::Exception)
-	end
-
+  context "defaults" do
+    its(:message) { should == 'TsJsonApi::Exception' }
+  end
+
+  context "custom exceptions" do
+    before { subject.message = "lorem ipsum" }
+    its(:message) { should == "lorem ipsum" }
+
+    it "should store rest client exception" do
+      subject.rest_client_exception.should be_nil
+      subject.rest_client_exception = RestClient::Exception.new
+      subject.rest_client_exception.should be_an_instance_of(RestClient::Exception)
+    end
+  end
 end
 
 describe TsJsonApi::ApiLimitExceededException do
-	it "should have 400 HTTP status code" do
-		TsJsonApi::ApiLimitExceededException.new.http_code.should == 400
-	end
+  it "should have 400 HTTP status code" do
+    TsJsonApi::ApiLimitExceededException.new.http_code.should == 400
+  end
 end
 
 describe TsJsonApi::ServerBrokeConnection do
-	it "should have 0 HTTP status code" do
-		TsJsonApi::ServerBrokeConnection.new.http_code.should == 0
-	end
+  it "should have 0 HTTP status code" do
+    TsJsonApi::ServerBrokeConnection.new.http_code.should == 0
+  end
 end
 
 describe TsJsonApi::ResourceNotFound do
-	it "should have 404 HTTP status code" do
-		TsJsonApi::ResourceNotFound.new.http_code.should == 404
-	end
-end
+  it "should have 404 HTTP status code" do
+    TsJsonApi::ResourceNotFound.new.http_code.should == 404
+  end
+end

data/spec/spec_helper.rb

@@ -14,4 +14,4 @@ RSpec.configure do |config|
   config.use_transactional_fixtures = true
 	config.color_enabled = true
   config.formatter     = 'documentation'
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ts_json_api
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -86,6 +86,8 @@ files:
 - lib/tasks/ts_json_api_tasks.rake
 - lib/ts_json_api/configure.rb
 - lib/ts_json_api/exceptions.rb
+- lib/ts_json_api/logging/file.rb
+- lib/ts_json_api/logging.rb
 - lib/ts_json_api/railtie.rb
 - lib/ts_json_api/requestor/drivers.rb
 - lib/ts_json_api/requestor/live_feed.rb
@@ -96,7 +98,6 @@ files:
 - 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
@@ -135,18 +136,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1665902326267123739
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1665902326267123739
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -174,3 +169,4 @@ test_files:
 - spec/dummy/db/schema.rb
 - spec/exceptions_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/ts_json_api/requestor/utility_methods.rb

@@ -1,17 +0,0 @@
-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