square 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96deb675316127d8568b8c0788d070f74095a0d6
-  data.tar.gz: 39cfdba4095dae9efa6570390b41834838500332
+  metadata.gz: 97640cf10444f7f9e41bb8fc733f6e4a058a5334
+  data.tar.gz: f564a55d6901749b0955f43e0d7fa69aa1f1e4c4
 SHA512:
-  metadata.gz: 1e3834e7da8769dce73df9146cab2622688680063a55b6950cee39ace4898b74a3bb60ea6dfcf6084538ff24dc4ee68a2af37b39ab9e9c17398b8a604a72de4a
-  data.tar.gz: db5dfacd28eff34a3010ba0468e3231888fd64cc197831acbef286442f0193084cf9fc09c36beed7fdde2f61a7fd2a9b34f2399e8caa5f2a690cb0172836f8f5
+  metadata.gz: 6ca3a04861c402d4770a156b4a0c371d449e75519a352ab67f95e70bccebdca813f825c4396f32ebbb23ae6f7f85201956d8f9949e6d204a60421c76f7a23655
+  data.tar.gz: 8c6f1eb1b9f612bb30f4c3655ca7c371ebc2e45d6336a67863102fb7fdbdb1f7081df2f055e70238d1a7d92bdade5a5fe7626fae49a5702564b8a88acdecf6be

data/README.md

@@ -1,6 +1,8 @@
 # Square
 
-TODO: Write a gem description
+Square API Client
+
+https://connect.squareup.com
 
 ## Installation
 
@@ -18,7 +20,44 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### OAuth 2.0
+
+    client = Square::Client.new(
+      '<your-client-id>',
+      redirect_uri: 'https://example.client.com/callback'
+    )
+
+    ## Authorization Request
+    redirect_to client.authorization_uri
+
+    ## Token Request
+    client.authorization_code = '<your-authorization-code>'
+    access_token = client.access_token!
+
+### Connect API
+
+    me = Square::Connect::Merchant.me access_token
+
+    ## Merchant API
+    me = me.fetch
+
+    ## Payments API
+    payments = me.payments
+
+    ## Payment API
+    payment = me.payment '<payment-id>'
+
+    ## Refunds API
+    refunds = me.refunds
+
+    ## Settlements API
+    settlements = me.settlements
+
+    ## Settlement API
+    settlement = me.settlement '<settlement-id>'
+
+    ## Bank Account API
+    bank_account = me.bank_account '<bank-accout-id>'
 
 ## Contributing
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/square/connect/bank_account.rb

@@ -6,9 +6,9 @@ module Square
       def initialize(*args)
         super do |attributes|
           self.merchant = if attributes[:merchant_id]
-            Merchant.new attributes[:merchant_id]
+            Merchant.new attributes[:merchant_id], access_token
           else
-            Merchant.new :me
+            Merchant.me access_token
           end
           self.bank_name = attributes[:bank_name]
           self.name = attributes[:name]
@@ -16,6 +16,7 @@ module Square
           self.routing_number = attributes[:routing_number]
           self.account_number_suffix = attributes[:account_number_suffix]
           self.currency_code = attributes[:currency_code]
+          self.endpoint = endpoint_for merchant.identifier, :bank_accounts, identifier
         end
       end
     end

data/lib/square/connect/connections/bank_accounts.rb

@@ -0,0 +1,16 @@
+module Square
+  module Connect
+    module Connections
+      module BankAccounts
+        def bank_account(bank_account_id, params = nil)
+          access_token_required!
+          BankAccount.new(
+            bank_account_id,
+            merchant_id: identifier,
+            access_token: access_token
+          ).fetch
+        end
+      end
+    end
+  end
+end

data/lib/square/connect/connections/payments.rb

@@ -13,6 +13,15 @@ module Square
             )
           end
         end
+
+        def payment(payment_id, params = nil)
+          access_token_required!
+          Payment.new(
+            payment_id,
+            merchant_id: identifier,
+            access_token: access_token
+          ).fetch
+        end
       end
     end
   end

data/lib/square/connect/connections/settlements.rb

@@ -13,6 +13,15 @@ module Square
             )
           end
         end
+
+        def settlement(settlement_id, params = nil)
+          access_token_required!
+          Settlement.new(
+            settlement_id,
+            merchant_id: identifier,
+            access_token: access_token
+          ).fetch
+        end
       end
     end
   end

data/lib/square/connect/merchant.rb

@@ -1,11 +1,10 @@
-require 'square/connect/connections'
-
 module Square
   module Connect
     class Merchant < Node
       include Connections::Payments
       include Connections::Refunds
       include Connections::Settlements
+      include Connections::BankAccounts
 
       attr_accessor :name, :email, :country_code, :language_code
 

data/lib/square/connect/node.rb

@@ -7,8 +7,8 @@ module Square
         attributes = args.extract_options!
         self.identifier = attributes[:id] || attributes[:identifier] || args.first
         self.access_token = tokenize attributes[:access_token] || args.second
-        self.endpoint = endpoint_for identifier
         yield attributes if block_given?
+        self.endpoint ||= endpoint_for identifier
       end
 
       def fetch

data/lib/square/connect/payment.rb

@@ -26,12 +26,12 @@ module Square
       def initialize(*args)
         super do |attributes|
           self.merchant = if attributes[:merchant_id]
-            Merchant.new attributes[:merchant_id]
+            Merchant.new attributes[:merchant_id], access_token
           else
-            Merchant.new :me
+            Merchant.me access_token
           end
           self.creator = if attributes[:creator_id]
-            Merchant.new attributes[:creator_id]
+            Merchant.new attributes[:creator_id], access_token
           end
           self.created_at = if attributes[:created_at]
             Time.parse attributes[:created_at]

data/lib/square/connect/refund.rb

@@ -1,27 +1,26 @@
 module Square
   module Connect
-    class Refund < Node
-      attr_accessor :type, :reason, :refunded_money, :created_at, :processed_at, :payment
+    class Refund
+      attr_accessor :identifier, :type, :reason, :refunded_money, :created_at, :processed_at, :payment
 
-      def initialize(*args)
-        super do |attributes|
-          self.type = attributes[:type]
-          self.reason = attributes[:reason]
-          self.refunded_money = if attributes[:refunded_money].present?
-            Money.new attributes[:refunded_money]
-          end
-          [
-            :created_at,
-            :processed_at
-          ].each do |time_key|
-            if attributes[time_key]
-              self.send "#{time_key}=", Time.parse(attributes[time_key])
-            end
-          end
-          self.payment = if attributes[:payment_id]
-            Payment.new attributes[:payment_id]
+      def initialize(attributes = {})
+        self.identifier = attributes[:id]
+        self.type = attributes[:type]
+        self.reason = attributes[:reason]
+        self.refunded_money = if attributes[:refunded_money].present?
+          Money.new attributes[:refunded_money]
+        end
+        [
+          :created_at,
+          :processed_at
+        ].each do |time_key|
+          if attributes[time_key]
+            self.send "#{time_key}=", Time.parse(attributes[time_key])
           end
         end
+        self.payment = if attributes[:payment_id]
+          Payment.new attributes[:payment_id]
+        end
       end
     end
   end

data/lib/square/connect/settlement.rb

@@ -10,7 +10,7 @@ module Square
             Time.parse attributes[:initiated_at]
           end
           self.bank_account = if attributes[:bank_account_id]
-            BankAccount.new attributes[:bank_account_id]
+            BankAccount.new attributes[:bank_account_id], access_token
           end
           self.total_money = if attributes[:total_money]
             Money.new attributes[:total_money]
@@ -18,6 +18,9 @@ module Square
           self.entries = Array(attributes[:entries]).collect do |entry_attributes|
             SettlementEntry.new entry_attributes
           end
+
+          merchnat_id = attributes[:merchant_id] || :me
+          self.endpoint = endpoint_for merchnat_id, :settlements, identifier
         end
       end
     end

data/spec/mock_response/bank_account/mine.json

@@ -0,0 +1,10 @@
+{
+  "id": "JGHJ0343",
+  "merchant_id": "AV76FTXT15L",
+  "bank_name": "Chase",
+  "name": "Dave's Business Account",
+  "type": "CHECKING",
+  "routing_number": "012345678",
+  "account_number_suffix": "1234",
+  "currency_code": "USD"
+}

data/spec/mock_response/settlements/single.json

@@ -0,0 +1,11 @@
+{
+  "id": "C:34GEWHCJGPR40",
+  "status": "SENT",
+  "bank_account_id": "JGHJ0343",
+  "initiated_at": "2013-01-02T08:00:00.000Z",
+  "type": "CREDIT",
+  "total_money": {
+    "amount": 5981,
+    "currency_code": "USD"
+  }
+}

data/spec/square/connect/bank_account_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Square::Connect::BankAccount do
+  let(:klass) { Square::Connect::BankAccount }
+  let(:identifier) { 'bank_account_id' }
+  let(:merchant_id) { 'merchant_id' }
+  let(:access_token) { 'access_token' }
+
+  describe '#initialize' do
+    context 'when merchant_id given' do
+      subject { klass.new identifier, merchant_id: merchant_id }
+      its(:endpoint) { should == File.join(Square::Connect::ROOT_URL, "#{merchant_id}/bank_accounts/#{identifier}") }
+    end
+
+    context 'otherwise' do
+      subject { klass.new identifier }
+      its(:endpoint) { should == File.join(Square::Connect::ROOT_URL, "me/bank_accounts/#{identifier}") }
+    end
+  end
+
+  describe '#fetch' do
+    let(:instance) { klass.new identifier, access_token }
+
+    it do
+      settlement = mock_request "me/bank_accounts/#{identifier}", 'bank_account/mine' do
+        instance.fetch
+      end
+      settlement.should be_a klass
+    end
+  end
+end

data/spec/square/connect/merchant_spec.rb

@@ -42,6 +42,16 @@ describe Square::Connect::Merchant do
     end
   end
 
+  describe '#fetch' do
+    it do
+      merchant = mock_request identifier, 'merchant/me' do
+        instance = klass.new identifier, access_token
+        instance.fetch
+      end
+      merchant.should be_a klass
+    end
+  end
+
   describe '.me' do
     subject { klass.me access_token }
     its(:identifier) { should == :me }

data/spec/square/connect/node_spec.rb

@@ -63,8 +63,4 @@ describe Square::Connect::Node do
       end
     end
   end
-
-  describe '.me' do
-
-  end
 end

data/spec/square/connect/payment_spec.rb

@@ -41,7 +41,7 @@ describe Square::Connect::Payment do
       fetched = mock_request instance.endpoint, 'payments/single' do
         instance.fetch
       end
-      fetched.should be_a Square::Connect::Payment
+      fetched.should be_a klass
     end
   end
 end

data/spec/square/connect/settlement_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Square::Connect::Settlement do
+  let(:klass) { Square::Connect::Settlement }
+  let(:identifier) { 'settlement_id' }
+  let(:merchant_id) { 'merchant_id' }
+  let(:access_token) { 'access_token' }
+
+  describe '#initialize' do
+    context 'when merchant_id given' do
+      subject { klass.new identifier, access_token, merchant_id: merchant_id }
+      its(:endpoint) { should == File.join(Square::Connect::ROOT_URL, "#{merchant_id}/settlements/#{identifier}") }
+    end
+
+    context 'otherwise' do
+      subject { klass.new identifier, access_token }
+      its(:endpoint) { should == File.join(Square::Connect::ROOT_URL, "me/settlements/#{identifier}") }
+    end
+  end
+
+  describe '#fetch' do
+    let(:instance) { klass.new identifier, access_token }
+
+    it do
+      settlement = mock_request "me/settlements/#{identifier}", 'settlements/single' do
+        instance.fetch
+      end
+      settlement.should be_a klass
+    end
+  end
+end

data/square.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'cover_me'
+  gem.add_development_dependency 'webmock'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: square
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - nov
@@ -80,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Square API client
 email:
 - nov@matake.jp
@@ -98,6 +112,7 @@ files:
 - lib/square/connect.rb
 - lib/square/connect/bank_account.rb
 - lib/square/connect/connections.rb
+- lib/square/connect/connections/bank_accounts.rb
 - lib/square/connect/connections/payments.rb
 - lib/square/connect/connections/refunds.rb
 - lib/square/connect/connections/settlements.rb
@@ -118,6 +133,7 @@ files:
 - lib/square/oauth2/access_token.rb
 - lib/square/oauth2/client.rb
 - spec/helpers/webmock_helper.rb
+- spec/mock_response/bank_account/mine.json
 - spec/mock_response/error/unauthorized.json
 - spec/mock_response/invalid_grant.json
 - spec/mock_response/merchant/me.json
@@ -125,14 +141,17 @@ files:
 - spec/mock_response/payments/single.json
 - spec/mock_response/refunds/list.json
 - spec/mock_response/settlements/list.json
+- spec/mock_response/settlements/single.json
 - spec/mock_response/token.json
 - spec/spec_helper.rb
+- spec/square/connect/bank_account_spec.rb
 - spec/square/connect/connections/payments_spec.rb
 - spec/square/connect/connections/refunds_spec.rb
 - spec/square/connect/connections/settlements_spec.rb
 - spec/square/connect/merchant_spec.rb
 - spec/square/connect/node_spec.rb
 - spec/square/connect/payment_spec.rb
+- spec/square/connect/settlement_spec.rb
 - spec/square/oauth2/access_token_spec.rb
 - spec/square/oauth2/client_spec.rb
 - square.gemspec