gocardless 0.1.0

data/spec/gocardless_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe GoCardless do
+  before do
+    unset_ivar GoCardless, :client
+    unset_ivar GoCardless, :account_details
+    @details = {:app_id => 'X', :app_secret => 'X', :token => 'X manage_merchant:1'}
+  end
+
+  describe ".account_details=" do
+    it "creates a Client instance" do
+      GoCardless::Client.expects :new
+      subject.account_details = @details
+    end
+
+    it "gets upset if the token is missing" do
+      expect {
+        subject.account_details = @details.merge(:token => nil)
+      }.to raise_exception GoCardless::ClientError
+    end
+  end
+
+
+  describe "delegated methods" do
+    %w(new_subscription_url new_pre_authorization_url new_bill_url confirm_resource).each do |name|
+      it "#{name} delegates to @client" do
+        subject.account_details = @details
+        subject.instance_variable_get(:@client).expects(name.to_sym)
+        subject.send(name)
+      end
+
+      it "raises an exception if the account details aren't set" do
+        expect {
+          subject.send(name)
+        }.to raise_exception GoCardless::ClientError
+      end
+    end
+  end
+
+end
+

data/spec/merchant_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe GoCardless::Merchant do
+  before :each do
+    @app_id = 'abc'
+    @app_secret = 'xyz'
+    @client = GoCardless::Client.new(:app_id => @app_id, :app_secret => @app_secret)
+    @client.access_token = 'TOKEN123 manage_merchant:123'
+    @redirect_uri = 'http://test.com/cb'
+  end
+
+  index_methods = [:subscriptions, :pre_authorizations, :users, :payments, :bills]
+
+  index_methods.each do |method|
+    it "##{method} works correctly" do
+      merchant = GoCardless::Merchant.new_with_client(@client)
+
+      data = [{:id => 1}, {:id => 2}]
+      stub_get(@client, data)
+
+      merchant.send(method).should be_a Array
+      merchant.send(method).length.should == 2
+      merchant.send(method).zip(data).each do |obj,attrs|
+        class_name = GoCardless::Utils.camelize(method.to_s).sub(/s$/, '')
+        obj.class.to_s.should == "GoCardless::#{class_name}"
+        attrs.each { |k,v| obj.send(k).should == v }
+      end
+    end
+  end
+end
+

data/spec/resource_spec.rb

@@ -0,0 +1,395 @@
+require 'spec_helper'
+
+describe GoCardless::Resource do
+  it "initializes from hash" do
+    test_resource = Class.new(GoCardless::Resource) do
+      attr_accessor :id, :name, :uri
+    end
+    props = {:id => 1, :name => 'test', :uri => 'http://test'}
+    resource = test_resource.new(props)
+    props.each { |k,v| resource.send(k).should == v }
+  end
+
+  describe "#date_writer" do
+    it "creates date writers properly" do
+      test_resource = Class.new(GoCardless::Resource) do
+        date_writer :created_at, :modified_at
+      end
+
+      test_resource.instance_methods.map(&:to_s).should include 'created_at='
+      test_resource.instance_methods.map(&:to_s).should include 'modified_at='
+    end
+
+    it "date writers work properly" do
+      test_resource = Class.new(GoCardless::Resource) do
+        date_writer :created_at
+      end
+
+      resource = test_resource.new
+      time = '2011-12-12T12:00:00Z'
+      resource.created_at = time
+      date_time = resource.instance_variable_get(:@created_at)
+      date_time.should be_instance_of DateTime
+      date_time.strftime('%Y-%m-%dT%H:%M:%SZ').should == time
+    end
+  end
+
+  describe "#date_accessor" do
+    it "creates date readers and writers properly" do
+      test_resource = Class.new(GoCardless::Resource) do
+        date_accessor :created_at, :modified_at
+      end
+
+      test_resource.instance_methods.map(&:to_s).should include 'created_at='
+      test_resource.instance_methods.map(&:to_s).should include 'created_at'
+      test_resource.instance_methods.map(&:to_s).should include 'modified_at='
+      test_resource.instance_methods.map(&:to_s).should include 'modified_at'
+    end
+
+    it "date readers work properly" do
+      test_resource = Class.new(GoCardless::Resource) do
+        date_accessor :created_at
+      end
+
+      resource = test_resource.new
+      date = DateTime.now
+      resource.instance_variable_set(:@created_at, date)
+      resource.created_at.should == date
+    end
+  end
+
+  describe ".find_with_client" do
+    it "instantiates the correct object" do
+      test_resource = Class.new(GoCardless::Resource) do
+        self.endpoint = '/test/:id'
+      end
+      mock_client = mock
+      mock_client.expects(:api_get).returns({:id => 123})
+      resource = test_resource.find_with_client(mock_client, 123)
+      resource.should be_a test_resource
+      resource.id.should == 123
+    end
+  end
+
+  describe ".find" do
+    it "calls find with the default client" do
+      test_resource = Class.new(GoCardless::Resource) do
+        self.endpoint = '/test/:id'
+      end
+      GoCardless.stubs(:client => mock)
+      test_resource.expects(:find_with_client).with(GoCardless.client, 1)
+      test_resource.find(1)
+      unset_ivar GoCardless, :client
+    end
+
+    it "raises a helpful error when there is no default client" do
+      test_resource = Class.new(GoCardless::Resource) do
+        self.endpoint = '/test/:id'
+      end
+      expect { test_resource.find(1) }.to raise_error
+    end
+  end
+
+  describe "#reference_writer" do
+    it "creates reference writers properly" do
+      test_resource = Class.new(GoCardless::Resource) do
+        reference_writer :merchant_id, :user_id
+      end
+
+      test_resource.instance_methods.map(&:to_s).should include 'merchant='
+      test_resource.instance_methods.map(&:to_s).should include 'merchant_id='
+      test_resource.instance_methods.map(&:to_s).should include 'user='
+      test_resource.instance_methods.map(&:to_s).should include 'user_id='
+    end
+
+    it "direct assignment methods work properly" do
+      test_resource = Class.new(GoCardless::Resource) do
+        reference_writer :user_id
+      end
+
+      resource = test_resource.new
+      resource.user = GoCardless::User.new(:id => 123)
+      resource.instance_variable_get(:@user_id).should == 123
+    end
+
+    it "requires args to end with _id" do
+      expect do
+        test_resource = Class.new(GoCardless::Resource) do
+          reference_writer :user
+        end
+      end.to raise_exception ArgumentError
+    end
+
+    it "fails with the wrong object type" do
+      test_resource = Class.new(GoCardless::Resource) do
+        reference_writer :user_id
+      end
+      expect do
+        test_resource.new.user = 'asdf'
+      end.to raise_exception ArgumentError
+    end
+  end
+
+  describe "#reference_reader" do
+    before :each do
+      @app_id = 'abc'
+      @app_secret = 'xyz'
+      @client = GoCardless::Client.new(:app_id => @app_id, :app_secret => @app_secret)
+      @redirect_uri = 'http://test.com/cb'
+    end
+
+    it "creates reference writers properly" do
+      test_resource = Class.new(GoCardless::Resource) do
+        reference_reader :merchant_id, :user_id
+      end
+
+      test_resource.instance_methods.map(&:to_s).should include 'merchant'
+      test_resource.instance_methods.map(&:to_s).should include 'merchant_id'
+      test_resource.instance_methods.map(&:to_s).should include 'user'
+      test_resource.instance_methods.map(&:to_s).should include 'user_id'
+    end
+
+    it "lookup methods work properly" do
+      test_resource = Class.new(GoCardless::Resource) do
+        reference_reader :user_id
+      end
+
+      resource = test_resource.new_with_client(@client)
+      resource.instance_variable_set(:@user_id, 123)
+      @client.access_token = 'TOKEN manage_merchant:123'
+      stub_get(@client, {:id => 123})
+      user = resource.user
+      user.should be_a GoCardless::User
+      user.id.should == 123
+    end
+
+    it "requires args to end with _id" do
+      expect do
+        test_resource = Class.new(GoCardless::Resource) do
+          reference_reader :user
+        end
+      end.to raise_exception ArgumentError
+    end
+  end
+
+  describe "#reference_accessor" do
+    it "creates reference readers and writers" do
+      test_resource = Class.new(GoCardless::Resource) do
+        reference_accessor :merchant_id, :user_id
+      end
+
+      test_resource.instance_methods.map(&:to_s).should include 'merchant'
+      test_resource.instance_methods.map(&:to_s).should include 'merchant_id'
+      test_resource.instance_methods.map(&:to_s).should include 'user'
+      test_resource.instance_methods.map(&:to_s).should include 'user_id'
+      test_resource.instance_methods.map(&:to_s).should include 'merchant='
+      test_resource.instance_methods.map(&:to_s).should include 'merchant_id='
+      test_resource.instance_methods.map(&:to_s).should include 'user='
+      test_resource.instance_methods.map(&:to_s).should include 'user_id='
+    end
+  end
+
+  it "#persisted? works" do
+    GoCardless::Resource.new.persisted?.should be_false
+    GoCardless::Resource.new(:id => 1).persisted?.should be_true
+  end
+
+  describe "#save" do
+    describe "succeeds and" do
+      before :each do
+        @test_resource = Class.new(GoCardless::Resource) do
+          self.endpoint = '/test'
+          attr_accessor :x, :y
+          creatable
+          updatable
+        end
+      end
+
+      after :each do
+        @test_resource = nil
+      end
+
+      it "sends the correct data parameters" do
+        client = mock
+        data = {:x => 1, :y => 2}
+        resource = @test_resource.new_with_client(client, data)
+        client.expects(:api_post).with(anything, data)
+        resource.save
+      end
+
+      it "sends the correct path" do
+        client = mock
+        resource = @test_resource.new_with_client(client)
+        client.expects(:api_post).with('/test', anything)
+        resource.save
+      end
+
+      it "POSTs when not persisted" do
+        client = mock
+        resource = @test_resource.new_with_client(client)
+        client.expects(:api_post)
+        resource.save
+      end
+
+      it "PUTs when already persisted" do
+        client = mock
+        resource = @test_resource.new_with_client(client, :id => 1)
+        client.expects(:api_put)
+        resource.save
+      end
+    end
+
+    it "succeeds when not persisted and create allowed" do
+      test_resource = Class.new(GoCardless::Resource) do
+        self.endpoint = '/test'
+        creatable
+      end
+
+      client = mock('client') { stubs :api_post }
+      test_resource.new_with_client(client).save
+    end
+
+    it "succeeds when persisted and update allowed" do
+      test_resource = Class.new(GoCardless::Resource) do
+        self.endpoint = '/test'
+        updatable
+      end
+
+      client = mock('client') { stubs :api_put }
+      test_resource.new_with_client(client, :id => 1).save
+    end
+
+    it "fails when not persisted and create not allowed" do
+      test_resource = Class.new(GoCardless::Resource) do
+        updatable
+      end
+
+      expect { test_resource.new.save }.to raise_error
+    end
+
+    it "fails when persisted and update not allowed" do
+      test_resource = Class.new(GoCardless::Resource) do
+        creatable
+      end
+
+      expect { test_resource.new(:id => 1).save }.to raise_error
+    end
+  end
+
+  it "#to_hash pulls out the correct attributes" do
+    test_resource = Class.new(GoCardless::Resource) do
+      attr_accessor :x
+    end
+
+    attrs = {:id => 1, :uri => 'http:', :x => 'y'}
+    resource = test_resource.new_with_client(mock, attrs)
+    resource.to_hash.should == attrs
+  end
+
+  it "#to_json converts to the correct JSON format" do
+    test_resource = Class.new(GoCardless::Resource) do
+      attr_accessor :amount
+      date_accessor :when
+      reference_accessor :person_id
+    end
+
+    bill = test_resource.new({
+      :amount => '10',
+      :when => DateTime.now,
+      :person_id => 15
+    })
+
+    result = JSON.parse(bill.to_json)
+    result['amount'].should == bill.amount
+    result['when'].should == bill.when.to_s
+    result['person_id'].should == 15
+  end
+
+  describe "resource permissions" do
+    it "are not given by default" do
+      GoCardless::Resource.creatable?.should be_false
+      GoCardless::Resource.updatable?.should be_false
+    end
+
+    it "are present when specified" do
+      class CreatableResource < GoCardless::Resource
+        creatable
+      end
+
+      class UpdatableResource < GoCardless::Resource
+        updatable
+      end
+
+      CreatableResource.creatable?.should be_true
+      CreatableResource.updatable?.should be_false
+
+      UpdatableResource.creatable?.should be_false
+      UpdatableResource.updatable?.should be_true
+
+      GoCardless::Resource.creatable?.should be_false
+      GoCardless::Resource.updatable?.should be_false
+    end
+  end
+
+  describe "sub_resource_uri methods" do
+    before :each do
+      @test_resource = Class.new(GoCardless::Resource) do
+      end
+      @attrs = {
+        'sub_resource_uris' => {
+          'bills' => 'https://test.com/api/bills/?merchant_id=1'
+        }
+      }
+    end
+
+    it "are defined on instances" do
+      r = @test_resource.new(@attrs)
+      r.should respond_to :bills
+    end
+
+    it "aren't defined for other instances of the class" do
+      @test_resource.new(@attrs)
+      resource = @test_resource.new
+      resource.should_not respond_to :bills
+    end
+
+    it "use the correct uri path" do
+      client = mock()
+      client.expects(:api_get).with('/api/bills/', anything).returns([])
+      r = @test_resource.new_with_client(client, @attrs)
+      r.bills
+    end
+
+    it "strips the api prefix from the path" do
+      client = mock()
+      client.expects(:api_get).with('/bills/', anything).returns([])
+      uris = {'bills' => 'https://test.com/api/v123/bills/'}
+      r = @test_resource.new_with_client(client, 'sub_resource_uris' => uris)
+      r.bills
+    end
+
+    it "use the correct query string params" do
+      client = mock()
+      client.expects(:api_get).with(anything, 'merchant_id' => '1').returns([])
+      r = @test_resource.new_with_client(client, @attrs)
+      r.bills
+    end
+
+    it "adds provided params to query string params" do
+      client = mock()
+      params = { 'merchant_id' => '1', :amount => '10.00' }
+      client.expects(:api_get).with(anything, params).returns([])
+      r = @test_resource.new_with_client(client, @attrs)
+      r.bills(:amount => '10.00')
+    end
+
+    it "return instances of the correct resource class" do
+      client = stub(:api_get => [{:id => 1}])
+      r = @test_resource.new_with_client(client, @attrs)
+      ret = r.bills
+      ret.should be_a Array
+      ret.first.should be_a GoCardless::Bill
+    end
+  end
+end
+