pin_up 0.4.2 → 0.5.0

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+env:
+  global:
+    secure: |-
+      Z7eqtE7oQVsmz2iw45MULCsk9Ff028nsPHJjX04GskTCeqhn2AgeFbNEjB7d
+      1mlrJDZyRggBW2ENK6Kti7p196hB1WfH52SYl9dZSLABWDW9oIKo46HjymNP
+      J9RERcoevctKkRGUCvyx0kvX1uN4iI56OJPXFAsYA+w0zAm/1/c=
+script: rspec spec

data/Gemfile

@@ -14,4 +14,6 @@ group :development do
   gem "simplecov", ">= 0"
   gem "webmock"
   gem "vcr"
+  gem 'guard-rspec'
+  gem 'terminal-notifier-guard'
 end

data/Gemfile.lock

@@ -10,11 +10,14 @@ GEM
     addressable (2.3.5)
     atomic (1.1.10)
     builder (3.2.2)
+    coderay (1.0.9)
     crack (0.4.0)
       safe_yaml (~> 0.9.0)
     diff-lcs (1.2.4)
     faraday (0.8.7)
       multipart-post (~> 1.1)
+    ffi (1.9.0)
+    formatador (0.2.4)
     git (1.2.5)
     github_api (0.10.1)
       addressable
@@ -23,6 +26,15 @@ GEM
       multi_json (~> 1.4)
       nokogiri (~> 1.5.2)
       oauth2
+    guard (1.8.1)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (3.0.2)
+      guard (>= 1.8)
+      rspec (~> 2.13)
     hashie (2.0.5)
     highline (1.6.19)
     httparty (0.11.0)
@@ -42,6 +54,12 @@ GEM
     json (1.8.0)
     jwt (0.1.8)
       multi_json (>= 1.5)
+    listen (1.2.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.3)
+    method_source (0.8.1)
     minitest (4.7.5)
     multi_json (1.7.7)
     multi_xml (0.5.4)
@@ -54,8 +72,17 @@ GEM
       multi_json (~> 1.0)
       multi_xml (~> 0.5)
       rack (~> 1.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rack (1.5.2)
     rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
     rdoc (3.12.2)
       json (~> 1.4)
     rspec (2.13.0)
@@ -77,6 +104,9 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
+    slop (3.4.5)
+    terminal-notifier-guard (1.5.3)
+    thor (0.18.1)
     thread_safe (0.1.0)
       atomic
     tzinfo (0.3.37)
@@ -89,11 +119,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  guard-rspec
   httparty
   jeweler (~> 1.8.4)
   rdoc (~> 3.12)
   rspec
   shoulda
   simplecov
+  terminal-notifier-guard
   vcr
   webmock

data/Guardfile

@@ -0,0 +1,45 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.md

@@ -4,6 +4,8 @@ A Ruby gem wrapper for the pin-payments (pin.net.au) API, all of it.
 
 Support for Ruby 1.9.x & Ruby 2.0.0
 
+[![Build Status](https://travis-ci.org/dNitza/pin_up.png)](https://travis-ci.org/dNitza/pin_up)
+
 ## Installation
 
     gem install pin_up
@@ -25,6 +27,18 @@ An option second paramater can be passed in to set the environment (:live or :te
 ### Charges
 ##### List All Charges
     Pin::Charges.all
+
+Show charges on a particular page:
+
+    Pin::Charges.all(6)
+
+With Pagination:
+
+    Pin::Charges.all(6,true)
+    # request = Pin::Charges.all(6,true)
+    # request[:response] => response hash
+    # request[:pagination] => "pagination":{"current":6,"previous":5,"next":7,"per_page":25,"pages":1,"count":15}
+
 ##### Find A Charge
     Pin::Charges.find("token")
 ##### Search For A Charge
@@ -40,10 +54,31 @@ See https://pin.net.au/docs/api/charges#search-charges for a full list of option
 ### Customers
 ##### List All Customers
     Pin::Customer.all
+
+Show customers on a particular page:
+
+    Pin::Customer.all(3)
+
+With Pagination:
+
+    Pin::Customer.all(3,true)
+
 ##### Find A Customer
     Pin::Customer.find('token')
 ##### List Charges For A Customer
     Pin::Customer.charges('cus_token')
+
+Show customers on a particular page:
+
+    Pin::Customer.charges(6)
+
+With Pagination:
+
+    Pin::Customer.all(6,true)
+    # request = Pin::Customer.all(6,true)
+    # request[:response] => response hash
+    # request[:pagination] => "pagination":{"current":6,"previous":5,"next":7,"per_page":25,"pages":1,"count":15}
+
 ##### Create A Customer
     Pin::Customer.create(email, hash_of_customer_details)
 
@@ -110,6 +145,8 @@ Create a YAML file under 'spec' called 'test_data.yml' and add in:
 
     PIN_SECRET: "your pin test secret"
 
+uncomment line 13 in spec_helper.rb and
+
 run
 
     rspec spec/*.rb

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/lib/pin_up/base.rb

@@ -68,16 +68,23 @@ module Pin
 
     ##
     # Builds a response of a collection if the response code is 200 otherwise an empty array is returned
-    def self.build_collection_response(response)
+    def self.build_collection_response(response, pagination=false)
       models = []
       if response.code == 200
-        response.parsed_response['response'].each do |model|
-          models << model
+        if pagination
+          response.parsed_response['response'].each do |model|
+            models << model
+          end
+          return {response: models, pagination: response.parsed_response['pagination']}
+        else
+          response.parsed_response['response'].each do |model|
+            models << model
+          end
         end
       elsif response.code >= 400
         Pin::PinError.handle_error(response.code, response.parsed_response)
       end
-      models
+      # models
     end
   end
 end

data/lib/pin_up/charge.rb

@@ -4,10 +4,15 @@ module Pin
   class Charges < Base
     ##
     # Lists all of the charges for your account
+    # args: page (Fixnum), pagination (Boolean)
     # returns: a collection of charge objects
+    #
+    # if pagination is passed, access the response hash with [:response]
+    # and the pagination hash with [:pagination]
+    #
     # https://pin.net.au/docs/api/charges#get-charges
-    def self.all
-      build_response(auth_get('charges'))
+    def self.all(page=nil, pagination=false)
+      build_collection_response(auth_get("charges?page=#{page}"),pagination)
     end
 
     ##

data/lib/pin_up/customer.rb

@@ -5,10 +5,15 @@ module Pin
 
     ##
     # Lists all customers for your account
+    # args: page (Fixnum), pagination (Boolean)
     # returns: a collection of customer objects
+    #
+    # if pagination is passed, access the response hash with [:response]
+    # and the pagination hash with [:pagination]
+    #
     # https://pin.net.au/docs/api/customers#get-customers
-    def self.all
-      build_collection_response(auth_get('customers'))
+    def self.all(page=nil, pagination=false)
+      build_collection_response(auth_get("customers?page=#{page}"), pagination)
     end
 
     ##
@@ -47,11 +52,15 @@ module Pin
 
     ##
     # Get a list of charges for a customer
-    # args: token (String)
+    # args: token (String), page (Fixnum), pagination (Boolean)
     # returns: a collection of charge objects
+    #
+    # if pagination is passed, access the response hash with [:response]
+    # and the pagination hash with [:pagination]
+    #
     # https://pin.net.au/docs/api/customers#get-customers-charges
-    def self.charges(token)
-      build_collection_response(auth_get("customers/#{token}/charges"))
+    def self.charges(token, page=nil, pagination=false)
+      build_collection_response(auth_get("customers/#{token}/charges?page=#{page}"), pagination)
     end
   end
 end

data/lib/pin_up/refund.rb

@@ -7,9 +7,13 @@ module Pin
     # Find a refund by charge token
     # returns: a collection of refund objects
     # args: token (String)
+    #
+    # if pagination is passed, access the response hash with [:response]
+    # and the pagination hash with [:pagination]
+    #
     # https://pin.net.au/docs/api/refunds#get-refunds
-    def self.find(token)
-      build_collection_response(auth_get("charges/#{token}/refunds"))
+    def self.find(token, page = nil, pagination = false)
+      build_collection_response(auth_get("charges/#{token}/refunds?page=#{page}"), pagination)
     end
 
     ##

data/pin_up.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "pin_up"
-  s.version = "0.4.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Nitsikopoulos"]
-  s.date = "2013-07-08"
+  s.date = "2013-08-18"
   s.description = "A Ruby gem wrapper for the pin-payments (pin.net.au) API"
   s.email = "dnitza@gmail.com"
   s.extra_rdoc_files = [
@@ -18,8 +18,19 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".idea/.name",
+    ".idea/.rakeTasks",
+    ".idea/encodings.xml",
+    ".idea/misc.xml",
+    ".idea/modules.xml",
+    ".idea/pin_up.iml",
+    ".idea/scopes/scope_settings.xml",
+    ".idea/vcs.xml",
+    ".idea/workspace.xml",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
+    "Guardfile",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
@@ -39,32 +50,7 @@ Gem::Specification.new do |s|
     "spec/customers_spec.rb",
     "spec/errors_spec.rb",
     "spec/refund_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/vcr/Base/should_list_succesfully_connect_to_Pin.yml",
-    "spec/vcr/Card/should_create_a_card_and_respond_with_the_card_detail_from_pin.yml",
-    "spec/vcr/Charge/should_create_a_charge_given_details.yml",
-    "spec/vcr/Charge/should_list_charges_in_Pin.yml",
-    "spec/vcr/Charge/should_not_show_a_charge_if_end_date_is_out_of_range.yml",
-    "spec/vcr/Charge/should_show_a_charge_given_a_search_term.yml",
-    "spec/vcr/Charge/should_show_a_charge_given_a_token.yml",
-    "spec/vcr/Customer/should_create_a_customer_given_a_card_token_customer_email.yml",
-    "spec/vcr/Customer/should_create_a_customer_given_an_email_and_card_details.yml",
-    "spec/vcr/Customer/should_list_charges_to_a_customer_given_a_token.yml",
-    "spec/vcr/Customer/should_list_customers.yml",
-    "spec/vcr/Customer/should_raise_an_error_if_an_attribute_is_missing_in_the_card_hash.yml",
-    "spec/vcr/Customer/should_show_a_customer_given_a_token.yml",
-    "spec/vcr/Customer/should_update_a_customer_given_a_token_and_details_to_update.yml",
-    "spec/vcr/Errors/Should_raise_a_ResourceNotFound_error_when_can_t_find_customer.yml",
-    "spec/vcr/Errors/should_raise_a_400_error_when_trying_to_make_a_payment_and_a_valid_card_gets_declined.yml",
-    "spec/vcr/Errors/should_raise_a_404_error_when_looking_for_a_customer_that_doesn_t_exist.yml",
-    "spec/vcr/Errors/should_raise_a_422_error_when_trying_to_make_a_payment_with_an_expired_card.yml",
-    "spec/vcr/Errors/should_raise_a_422_error_when_trying_to_make_a_payment_with_an_invalid_card.yml",
-    "spec/vcr/Errors/should_raise_a_422_error_when_trying_to_update_missing_a_param.yml",
-    "spec/vcr/Errors/should_show_a_charge_given_a_token.yml",
-    "spec/vcr/Refund/should_create_a_refund_for_a_given_amount_and_charge.yml",
-    "spec/vcr/Refund/should_create_a_refund_for_the_entire_amount_of_a_charge_if_no_amount_given.yml",
-    "spec/vcr/Refund/should_list_all_refunds_made_to_a_charge_given_a_token.yml",
-    "spec/vcr/Refund/should_return_nothing_if_looking_for_a_charge_without_a_refund.yml"
+    "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/dNitza/pin_up"
   s.licenses = ["MIT"]
@@ -85,6 +71,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
       s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<terminal-notifier-guard>, [">= 0"])
       s.add_runtime_dependency(%q<httparty>, [">= 0"])
     else
       s.add_dependency(%q<httparty>, [">= 0"])
@@ -96,6 +84,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<webmock>, [">= 0"])
       s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<terminal-notifier-guard>, [">= 0"])
       s.add_dependency(%q<httparty>, [">= 0"])
     end
   else
@@ -108,6 +98,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<webmock>, [">= 0"])
     s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<terminal-notifier-guard>, [">= 0"])
     s.add_dependency(%q<httparty>, [">= 0"])
   end
 end

data/spec/charges_spec.rb

@@ -10,7 +10,7 @@ describe "Charge", :vcr, class: Pin::Charges do
   end
 
   it "should show a charge given a token" do
-    Pin::Charges.find("ch_0kdOMXP7gG0_W_Vh8qAWdA")["token"].should == "ch_0kdOMXP7gG0_W_Vh8qAWdA"
+    Pin::Charges.find("ch_0kdOMXP7gG0_W_Vh8qAWdA")["token"].should match(/^[a-z]{2}[_]/)
   end
 
   it "should show a charge given a search term" do
@@ -22,7 +22,15 @@ describe "Charge", :vcr, class: Pin::Charges do
   end
 
   it "should create a charge given details" do
-    options = {email: "dNitza@gmail.com", description: "A new charge from testing Pin gem", amount: "400", currency: "AUD", ip_address: "127.0.0.1", customer_token: "cus_sRtAD2Am-goZoLg1K-HVpA"   }
+    options = {email: "dNitza@gmail.com", description: "A new charge from testing Pin gem", amount: "400", currency: "AUD", ip_address: "127.0.0.1", customer_token: "cus_8ImkZdEZ6BXUA6NcJDZg_g"   }
     Pin::Charges.create(options)["success"].should eq true
   end
+
+  it "should return pagination if 'pagination' is true" do
+    Pin::Charges.all(3,true)[:pagination]["current"] == 3
+  end
+
+  it "should list charges on a page given a page" do
+    Pin::Charges.all(1).should_not == []
+  end
 end

data/spec/customers_spec.rb

@@ -1,13 +1,32 @@
 require 'spec_helper'
 
-
 describe "Customer", :vcr, class: Pin::Customer do
   before(:each) do
     Pin::Base.new(ENV["PIN_SECRET"], :test)
   end
 
   it "should list customers" do
-    Pin::Customer.all.should_not == nil
+    Pin::Customer.all.should_not == []
+  end
+
+  it "should go to a specific page when page paramater is passed" do
+    request = Pin::Customer.all(20,true)
+    request[:pagination]["current"].should == 20
+  end
+
+  it "should list customers on a page given a page" do
+    request = Pin::Customer.all(1,true)
+    request[:response].should_not == []
+  end
+
+  it "should return pagination if true is passed for pagination" do
+    request = Pin::Customer.all(1,true)
+    request[:pagination].keys.include?(["current", "previous", "next", "per_page", "pages", "count"])
+  end
+
+  it "should not list customers on a page given a page if there are no customers" do
+    request = Pin::Customer.all(25,true)
+    request[:response].should == []
   end
 
   it "should show a  customer given a token" do
@@ -15,7 +34,15 @@ describe "Customer", :vcr, class: Pin::Customer do
   end
 
   it "should list charges to a customer given a token" do
-    Pin::Customer.charges('cus_8ImkZdEZ6BXUA6NcJDZg_g')[0]['token'].should == "ch_0kdOMXP7gG0_W_Vh8qAWdA"
+    Pin::Customer.charges('cus_8ImkZdEZ6BXUA6NcJDZg_g')[0]['token'].should match(/^[a-z]{2}[_]/)
+  end
+
+  it "should show pagination on a page given a token and a page" do
+    Pin::Customer.charges('cus_8ImkZdEZ6BXUA6NcJDZg_g',5,true)[:pagination]["current"] == 5
+  end
+
+  it "should list charges to a customer on a page given a token and a page" do
+    Pin::Customer.charges('cus_8ImkZdEZ6BXUA6NcJDZg_g',1,true)[:response][0]['token'].should match(/^[a-z]{2}[_]/)
   end
 
   it "should create a customer given an email and card details" do