paid 1.0.1 → 1.0.2

data/lib/paid/util.rb

@@ -1,46 +1,6 @@
 module Paid
   module Util
 
-    def self.query_string(params)
-      if params && params.any?
-        return query_array(params).join('&')
-      else
-        return ""
-      end
-    end
-
-    # Three major use cases (and nesting of them needs to be supported):
-    #   { :a => { :b => "bvalue" } }  => ["a[b]=bvalue"]
-    #   { :a => [1, 2] }           => ["a[]=1", "a[]=2"]
-    #   { :a => "value" }          => ["a=value"]
-    def self.query_array(params, key_prefix=nil)
-      ret = []
-      params.each do |key, value|
-        if params.is_a?(Array)
-          value = key
-          key = ''
-        end
-        key_suffix = escape(key)
-        full_key = key_prefix ? "#{key_prefix}[#{key_suffix}]" : key_suffix
-
-        if value.is_a?(Hash) || value.is_a?(Array)
-          # Handles the following cases:
-          #   { :a => { :b => "bvalue" } }  => ["a[b]=bvalue"]
-          #   { :a => [1, 2] }           => ["a[]=1", "a[]=2"]
-          ret += query_array(value, full_key)
-        else
-          # Handles the base case with just key and value:
-          #   { :a => "value" } => ["a=value"]
-          ret << "#{full_key}=#{escape(value)}"
-        end
-      end
-      ret
-    end
-
-    def self.escape(val)
-      URI.escape(val.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-    end
-
     def self.symbolize_keys(obj)
       if obj.is_a?(Hash)
         ret = {}
@@ -73,5 +33,19 @@ module Paid
       end
     end
 
+    def self.constantize(str, prefix=false)
+      str = str.to_s
+      begin
+        str.split('::').reduce(Module, :const_get)
+      rescue NameError => e
+        if prefix
+          raise e
+        else
+          p = "#{self.name}".split("::").first
+          constantize("#{p}::#{str}", true)
+        end
+      end
+    end
+
   end
 end

data/paid.gemspec

@@ -8,7 +8,7 @@ spec = Gem::Specification.new do |s|
   s.description = 'Paid is the programmatic way to manage payments.  See https://paidapi.com for details.'
   s.homepage = 'http://docs.paidapi.com'
   s.authors = ['Jon Calhoun', 'Ryan Jackson']
-  s.email = ['joncalhoun@gmail.com', 'ryan@paidapi.com']
+  s.email = ['jon@apibits.com', 'ryan@paidapi.com']
   s.version = Paid::VERSION
   s.license = 'MIT'
 

data/test/paid/{api_class_test.rb → _api_resource_test.rb}

@@ -2,7 +2,7 @@
 require File.expand_path('../../test_helper', __FILE__)
 
 module Paid
-  class ApiClassTest < Test::Unit::TestCase
+  class APIResourceTest < ::Test::Unit::TestCase
 
     context 'Non-network actions' do
       setup do
@@ -12,11 +12,11 @@ module Paid
         @mock.expects(:delete).never
       end
 
-      should 'not fetch over the network when creating a new APIClass' do
+      should 'not fetch over the network when creating a new APIResource' do
         MockResource.new('fake_id')
       end
 
-      should 'not fetch over the network when creating a new APIClass from a hash' do
+      should 'not fetch over the network when creating a new APIResource from a hash' do
         MockResource.construct(test_mock_resource)
       end
 
@@ -84,7 +84,7 @@ module Paid
       end
     end
 
-    context 'APIClass :default_params' do
+    context 'APIResource :default_params' do
       context 'api_instance_method' do
         setup do
           @response = test_response(test_mock_resource_list)
@@ -199,7 +199,7 @@ module Paid
     end
 
 
-    context 'APIClass#attribute' do
+    context 'APIResource#attribute' do
       should 'create a getter method' do
         assert(MockResource.method_defined?(:name))
       end
@@ -210,52 +210,66 @@ module Paid
 
       should 'have no changed attributes after init' do
         mr = MockResource.new(test_mock_resource)
-        assert(mr.changed_attributes.empty?)
+        assert(mr.changed_api_attributes.empty?)
       end
 
       should 'keep track of changed attributes' do
         mr = MockResource.new(test_mock_resource)
-        assert(mr.changed_attributes.empty?)
+        assert(mr.changed_api_attributes.empty?)
         mr.name = "new name"
-        assert_equal({:name => "new name"}, mr.changed_attributes)
+        assert_equal({:name => "new name"}, mr.changed_api_attributes)
       end
 
       should 'keep track of changed arrays' do
         mr = MockResource.new(test_mock_resource)
-        assert(mr.changed_attributes.empty?)
+        assert(mr.changed_api_attributes.empty?)
         mr.tarray << "new"
-        assert_equal({:tarray => test_mock_resource[:tarray] + ["new"]}, mr.changed_attributes)
+        assert_equal({:tarray => test_mock_resource[:tarray] + ["new"]}, mr.changed_api_attributes)
       end
 
       should 'keep track of changed hashes' do
         mr = MockResource.new(test_mock_resource)
-        assert(mr.changed_attributes.empty?)
+        assert(mr.changed_api_attributes.empty?)
         mr.thash[:some_key] = "new value"
-        assert_equal({:thash => { :some_key => "new value" }}, mr.changed_attributes)
+        assert_equal({:thash => { :some_key => "new value" }}, mr.changed_api_attributes)
       end
 
       context 'constructors' do
         should 'instantiate on #new' do
           mr = MockResource.new(test_mock_resource)
           assert(mr.nested.is_a?(NestedResource))
+          assert(mr.nested_alt.is_a?(NestedResource))
+          assert(mr.nested_with.is_a?(NestedWithParent))
+          assert_equal(mr.path + "/nested_path", mr.nested_with.path)
         end
 
         should 'instantiate on #construct' do
           mr = MockResource.construct(test_mock_resource)
           assert(mr.nested.is_a?(NestedResource))
+          assert(mr.nested_alt.is_a?(NestedResource))
+          assert(mr.nested_with.is_a?(NestedWithParent))
+          assert_equal(mr.path + "/nested_path", mr.nested_with.path)
         end
 
         should 'instantiate on #refresh_from' do
           mr = MockResource.new('fake_id')
           assert(mr.nested.nil?)
-
           mr.refresh_from(test_mock_resource)
           assert(mr.nested.is_a?(NestedResource))
+          assert(mr.nested_alt.is_a?(NestedResource))
+          assert(mr.nested_with.is_a?(NestedWithParent))
+          assert_equal(mr.path + "/nested_path", mr.nested_with.path)
+        end
+
+        should 'with default values' do
+          mr = MockResource.new('fake_id')
+          assert(mr.nested_with.is_a?(NestedWithParent))
+          assert_equal(mr.path + "/nested_path", mr.nested_with.path)
         end
       end
     end
 
-    context 'APIClass :constructor' do
+    context 'APIResource :constructor' do
       context 'for api_class_method' do
         setup do
           @mock.expects(:get).once.returns(test_response(test_mock_resource))
@@ -313,7 +327,7 @@ module Paid
       end
     end
 
-    context 'APIClass api_*_method arguments' do
+    context 'APIResource api_*_method arguments' do
       should 'throw an ArgumentError if too few arguments are provided' do
         assert_raises(ArgumentError) { MockResource.retrieve }
       end
@@ -364,7 +378,7 @@ module Paid
       end
     end
 
-    context 'APIClass api_instance_method paths' do
+    context 'APIResource api_instance_method paths' do
       should 'use the provided argument if it is present' do
         response = test_response(test_mock_resource)
         @mock.expects(:get).with("#{Paid.api_base}/custom_path", anything, anything).returns(response)
@@ -392,7 +406,7 @@ module Paid
       end
     end
 
-    context 'APIClass api_class_method paths' do
+    context 'APIResource api_class_method paths' do
       should 'use the provided argument if it is present' do
         response = test_response(test_mock_resource)
         @mock.expects(:get).with("#{Paid.api_base}#{MockResource.path}/fake_id", anything, anything).returns(response)

data/test/paid/account_test.rb

@@ -3,7 +3,7 @@ require File.expand_path('../../test_helper', __FILE__)
 module Paid
   class AccountTest < Test::Unit::TestCase
     setup do
-      @account_url = "#{Paid.api_base}/v0/account"
+      @account_url = "#{Paid.api_base}/account"
     end
 
     should 'be retrievable' do
@@ -41,8 +41,8 @@ module Paid
     end
 
     should 'be registered' do
-      assert(APIClass.subclasses.include?(Paid::Account))
-      assert_equal(Paid::Account, APIClass.subclass_fetch("account"))
+      assert(APIResource.api_subclasses.include?(Paid::Account))
+      assert_equal(Paid::Account, APIResource.api_subclass_fetch("account"))
     end
 
   end

data/test/paid/api_list_test.rb

@@ -1,16 +1,22 @@
 require File.expand_path('../../test_helper', __FILE__)
 
 module Paid
-  class ApiListTest < Test::Unit::TestCase
+  class APIListTest < ::Test::Unit::TestCase
 
-    should 'have an object attribute' do
-      assert(Paid::APIList.method_defined?(:object))
-      assert(Paid::APIList.method_defined?(:object=))
-    end
+    context '#new / #initialize' do
+      setup do
+        @fake_resource = {:data => "fake-data"}
+        @list = APIList.new(APIResource, [@fake_resource])
+      end
+
+      should 'set the klass' do
+        assert_equal(APIResource, @list.klass)
+      end
 
-    should 'have an data attribute' do
-      assert(Paid::APIList.method_defined?(:data))
-      assert(Paid::APIList.method_defined?(:data=))
+      should 'convert the data to klass instances' do
+        assert(@list.first.is_a?(APIResource))
+        assert_equal(@fake_resource, @list.first.json)
+      end
     end
 
   end

data/test/paid/api_method_test.rb

@@ -0,0 +1,89 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Paid
+  class APIMethodTest < ::Test::Unit::TestCase
+    setup do
+      @method = :get
+      @path = "/testing"
+      @params = { :param_a => "1" }
+      @headers = { :header_a => "a" }
+      @object = mock
+      @api_method = APIMethod.new(@method, @path, @params, @headers, @object)
+    end
+
+    context '#new / #initialize' do
+      should 'set the api_key' do
+        assert_equal(Paid.api_key, @api_method.api_key)
+      end
+
+      should 'set the api_base' do
+        assert_equal(Paid.api_base, @api_method.api_base)
+      end
+
+      should 'use PathBuilder with path, object, and params' do
+        PathBuilder.expects(:build).with(@path, @object, @params).returns(@path)
+        APIMethod.new(@method, @path, @params, @headers, @object)
+      end
+
+      should 'use ParamsBuilder with params' do
+        ParamsBuilder.expects(:build).with(@params).returns(@params)
+        APIMethod.new(@method, @path, @params, @headers, @object)
+      end
+
+      should 'use HeadersBuilder with headers, api_key, and nil auth_header' do
+        HeadersBuilder.expects(:build).with(@headers, Paid.api_key, nil).returns(@headers)
+        APIMethod.new(@method, @path, @params, @headers, @object)
+      end
+
+      should 'verify the api key exists' do
+        Paid.api_key = nil
+        assert_raises(AuthenticationError) do
+          APIMethod.new(@method, @path, @params, @headers, @object)
+        end
+      end
+    end
+
+    context '#execute' do
+      setup do
+        @mock_response = mock
+        @mock_response.stubs(:body).returns('{"status": "success"}')
+        @mock_response.stubs(:code).returns(200)
+      end
+
+      should 'call Requester.request with the set attrs' do
+        Requester.expects(:request).with(@method, @api_method.url, @api_method.params, @api_method.headers).returns(@mock_response)
+        @api_method.execute
+      end
+
+      should 'create an APIError if the request fails' do
+        Requester.expects(:request).raises(RestClient::RequestTimeout.new)
+
+        assert_raises(APIError) { @api_method.execute }
+      end
+
+      should 'return the response parsed as json' do
+        Requester.expects(:request).returns(@mock_response)
+        assert_equal({:status => "success"}, @api_method.execute)
+      end
+
+      should 'return an AuthenticationError if the status is 401' do
+        error = RestClient::ExceptionWithResponse.new
+        error.expects(:http_code).returns(401)
+
+        Requester.expects(:request).raises(error)
+        assert_raises(AuthenticationError) { @api_method.execute }
+      end
+    end
+
+    context '#response_json' do
+      setup do
+        @api_method.response_body = 'not-valid-json'
+      end
+
+      should 'throw an error if the response_body isnt valid json' do
+        assert_raises(APIError) { @api_method.response_json }
+      end
+    end
+
+  end
+end

data/test/paid/customer_test.rb

@@ -3,7 +3,7 @@ require File.expand_path('../../test_helper', __FILE__)
 module Paid
   class CustomerTest < Test::Unit::TestCase
     setup do
-      @customer_url = "#{Paid.api_base}/v0/customers"
+      @customer_url = "#{Paid.api_base}/customers"
     end
 
     context 'Customer class' do
@@ -16,7 +16,10 @@ module Paid
 
       should 'be retrieveable by external_id' do
         external_id = "external_id_for_cust"
-        @mock.expects(:get).once.with("#{@customer_url}/by_external_id/#{external_id}", anything, anything).returns(test_response(test_customer))
+        @mock.expects(:get).once.with do |url, headers, params|
+          Regexp.new("/customers/by_external_id").match(url) &&
+          params[:external_id] == external_id
+        end.returns(test_response(test_customer))
         customer = Paid::Customer.by_external_id(external_id)
         assert(customer.is_a?(Paid::Customer))
       end
@@ -54,7 +57,7 @@ module Paid
         customer.email = "new_email@domain.com"
 
         @mock.expects(:put).once.with do |url, headers, params|
-          params == customer.changed_attributes && url == "#{@customer_url}/#{customer.id}"
+          !params.nil? && url == "#{@customer_url}/#{customer.id}"
         end.returns(test_response(test_customer))
 
         # This should update this instance with test_customer since it was returned
@@ -65,7 +68,9 @@ module Paid
 
       should 'be able to generate an invoice' do
         customer = Paid::Customer.new(test_customer)
-        @mock.expects(:post).once.with("#{@customer_url}/#{customer.id}/generate_invoice", anything, anything).returns(test_response(test_invoice))
+        @mock.expects(:post).once.with do |url, headers, params|
+          Regexp.new("/customers/#{customer.id}/generate_invoice").match(url)
+        end.returns(test_response(test_invoice))
 
         invoice = customer.generate_invoice
         assert(invoice.is_a?(Paid::Invoice))
@@ -73,7 +78,10 @@ module Paid
 
       should 'be able to list invoices' do
         customer = Paid::Customer.new(test_customer)
-        @mock.expects(:get).once.with("#{Paid.api_base}#{Paid::Invoice.path}?customer=#{customer.id}", anything, anything).returns(test_response(test_invoice_list))
+        @mock.expects(:get).once.with do |url, headers, params|
+          Regexp.new("/invoices").match(url) &&
+          params[:customer] == customer.id
+        end.returns(test_response(test_invoice_list))
 
         invoices = customer.invoices
         assert(invoices.is_a?(Paid::APIList))
@@ -84,7 +92,10 @@ module Paid
 
       should 'be able to list transactions' do
         customer = Paid::Customer.new(test_customer)
-        @mock.expects(:get).once.with("#{Paid.api_base}#{Paid::Transaction.path}?customer=#{customer.id}", anything, anything).returns(test_response(test_transaction_list))
+        @mock.expects(:get).once.with do |url, headers, params|
+          Regexp.new("/transactions").match(url) &&
+          params[:customer] == customer.id
+        end.returns(test_response(test_transaction_list))
 
         transactions = customer.transactions
         assert(transactions.is_a?(Paid::APIList))
@@ -97,8 +108,7 @@ module Paid
 
     context 'Retrieved Paid::Customer instance' do
       setup do
-        @mock.expects(:get).once.returns(test_response(test_customer))
-        @customer = Paid::Customer.retrieve('customer_id')
+        @customer = Paid::Customer.new(test_customer)
       end
 
       should 'have the id attribute' do
@@ -184,8 +194,8 @@ module Paid
     end
 
     should 'be registered' do
-      assert(APIClass.subclasses.include?(Paid::Customer))
-      assert_equal(Paid::Customer, APIClass.subclass_fetch("customer"))
+      assert(APIResource.api_subclasses.include?(Paid::Customer))
+      assert_equal(Paid::Customer, APIResource.api_subclass_fetch("customer"))
     end
 
   end

data/test/paid/event_test.rb

@@ -3,7 +3,7 @@ require File.expand_path('../../test_helper', __FILE__)
 module Paid
   class EventTest < Test::Unit::TestCase
     setup do
-      @event_url = "#{Paid.api_base}/v0/events"
+      @event_url = "#{Paid.api_base}/events"
     end
 
     context 'Event class' do
@@ -58,7 +58,6 @@ module Paid
       end
 
       should 'have & convert the data attribute' do
-        assert(@event.data.is_a?(Paid::APIClass))
         event2 = Paid::Event.new(test_event(test_invoice))
         assert(event2.data.is_a?(Paid::Invoice))
       end
@@ -66,8 +65,8 @@ module Paid
     end
 
     should 'be registered' do
-      assert(APIClass.subclasses.include?(Paid::Event))
-      assert_equal(Paid::Event, APIClass.subclass_fetch("event"))
+      assert(APIResource.api_subclasses.include?(Paid::Event))
+      assert_equal(Paid::Event, APIResource.api_subclass_fetch("event"))
     end
 
   end