the-city-admin 0.2.1 → 0.3.0

data/lib/common.rb

@@ -26,7 +26,8 @@ module TheCity
         begin
           error_messages = JSON.parse(response.body)['error_message']
         rescue
-          raise TheCityExceptions::UnknownErrorConnectingToTheCity.new('Unknown error when connecting to The City')
+          response_code_desc = response.headers.partition("\r\n")[0].sub(/^\S+/, '') rescue nil
+          raise TheCityExceptions::UnknownErrorConnectingToTheCity.new("Unknown error when connecting to The City.#{response_code_desc}")
         else
           raise TheCityExceptions::TheCityResponseError.new(error_messages)
         end

data/lib/readers/api_reader.rb

@@ -2,6 +2,7 @@ module TheCity
 
   # This adapter is the standard for all loading objects.
   class ApiReader
+    attr_reader :headers
 
     # Constructor
     # def initialize
@@ -15,14 +16,35 @@ module TheCity
       #   data = @cacher.get_data( @class_key )
       # else
         @url_data_params ||= {}
-        response = TheCity::admin_request(:get, @url_data_path, @url_data_params) 
-        data = JSON.parse(response.body)     
-        @cacher.save_data(@class_key, data) unless @cacher.nil?  
+        response = TheCity::admin_request(:get, @url_data_path, @url_data_params)
+        data = JSON.parse(response.body)
+        @headers = parse_headers(response.headers) if response.headers
+        @cacher.save_data(@class_key, data) unless @cacher.nil?
       #end   
 
       return data
     end
 
+    def parse_headers(headers)
+      Hash[headers.split("\r\n").collect { |pair| pair.split(': ') }]
+    end
+
+    # Returns either the value of the X-City-RateLimit-Limit-By-Ip header or
+    # X-City-RateLimit-Limit-By-Account header, whichever is lower.
+    def rate_limit
+      if @headers
+        [@headers['X-City-RateLimit-Limit-By-Ip'].to_i, @headers['X-City-RateLimit-Limit-By-Account'].to_i].min
+      end
+    end
+
+    # Returns either the value of the X-City-RateLimit-Remaining-By-Ip header or
+    # X-City-RateLimit-Remaining-By-Account header, whichever is lower.
+    def rate_limit_remaining
+      if @headers
+        [@headers['X-City-RateLimit-Remaining-By-Ip'].to_i, @headers['X-City-RateLimit-Remaining-By-Account'].to_i].min
+      end
+    end
+
   end
 
 end

data/spec/api/group_checkin_list_spec.rb

@@ -1,4 +1,4 @@
-require File.join(Dir.pwd, 'spec', 'spec_helper')
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe 'GroupCheckinList' do
 
@@ -11,7 +11,7 @@ describe 'GroupCheckinList' do
   end
 
 
-  it 'should pass if group checkin list attribute is not specifed' do
+  it 'should pass if group checkin list attribute is not specified' do
     group_id = 123
     request_data = FactoryGirl.attributes_for(:group_checkin_list, {
       :total_entries => 1,

data/spec/readers/api_reader_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TheCity::ApiReader do
+
+  it "should include City headers" do
+    headers = "X-City-RateLimit-Limit-By-Ip: 2200\r\nX-City-RateLimit-Remaining-By-Ip: 2199\r\n"
+    TheCity.stub(:admin_request).and_return(TheCityResponse.new(200, {}.to_json, headers))
+    reader = TheCity::ApiReader.new
+    reader.load_feed.should == {}
+    reader.headers['X-City-RateLimit-Limit-By-Ip'].should == '2200'
+    reader.headers['X-City-RateLimit-Remaining-By-Ip'].should == '2199'
+  end
+
+  it "should include convenience methods for reading rate limit data" do
+    headers = ["X-City-RateLimit-Limit-By-Ip: 2000",
+               "X-City-RateLimit-Remaining-By-Ip: 1987",
+               "X-City-RateLimit-Limit-By-Account: 3000",
+               "X-City-RateLimit-Remaining-By-Account: 1561"].join("\r\n")
+    TheCity.stub(:admin_request).and_return(TheCityResponse.new(200, {}.to_json, headers))
+    reader = TheCity::ApiReader.new
+    reader.load_feed.should == {}
+    reader.rate_limit.should == 2000
+    reader.rate_limit_remaining.should == 1561
+  end
+
+end

data/spec/spec_helper.rb

@@ -3,7 +3,6 @@
 #
 # Author:: Wes Hays <weshays@gbdev.com> 
 # Link:: https://github.com/weshays/admin-api-ruby
-# Version:: 0.1a
 # Package:: TheCity::Admin
 
 
@@ -18,7 +17,7 @@ require 'factory_girl'
 Dir.glob(File.dirname(__FILE__) + "/factories/*").each { |f| require f }
 
 
-TheCityResponse = Struct.new(:code, :body)
+TheCityResponse = Struct.new(:code, :body, :headers)
 
 RSpec.configure do |config|
   config.tty = true

data/thecity_admin_api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   PROJECT_GEM = 'the-city-admin'
-  PROJECT_GEM_VERSION = '0.2.1'
+  PROJECT_GEM_VERSION = '0.3.0'
   
   s.name = PROJECT_GEM
   s.version = PROJECT_GEM_VERSION
@@ -23,17 +23,3 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 end
-
-
-  #s.require_path = 'lib/'
-  
-  # s.files = ['LICENSE',
-  #            'README',
-  #            'lib/common_project_tasks.rb',
-  #            'lib/common_project_tasks/app.rake',
-  #            'examples/app_vars.yml']
-             
-  # s.has_rdoc = true
-  # s.extra_rdoc_files = %w{README LICENSE}
-  # s.rdoc_options << '--title' << 'Common Project Tasks Documentation' <<
-  #                   '--main' << 'README' << '-q'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the-city-admin
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-24 00:00:00.000000000 Z
+date: 2012-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -303,6 +303,7 @@ files:
 - spec/factories/web_hook.rb
 - spec/factories/web_hook_list.rb
 - spec/functional/the_city_admin_spec.rb
+- spec/readers/api_reader_spec.rb
 - spec/readers/user_reader_spec.rb
 - spec/spec_helper.rb
 - spec/writers/skill_writer_spec.rb
@@ -435,6 +436,7 @@ test_files:
 - spec/factories/web_hook.rb
 - spec/factories/web_hook_list.rb
 - spec/functional/the_city_admin_spec.rb
+- spec/readers/api_reader_spec.rb
 - spec/readers/user_reader_spec.rb
 - spec/spec_helper.rb
 - spec/writers/skill_writer_spec.rb