amazon_flex_pay 0.10.0 → 0.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68253a01c923bf46f09496fdee4ace08ea2dd9ed
+  data.tar.gz: 6b40beb54028b808d4f41b36e0a7ac3e4e005dbb
+SHA512:
+  metadata.gz: 7a7aaf429c63410b93674f2ae06635d46bbe0e551993f8e818714683a7b9d5a33e3e2570f330bbba30cc8f362359ee6942a16cfdefcd24934f16d83c56214c08
+  data.tar.gz: be5f27f8a729e0f68c494eafa105c7a2af8a4df3db4ce6fcbe462b3f6a862a53b2b9ba133a48dee74724e79beef1421cbec104c3f6cca73a5cc35d75bd293d5e

data/README.rdoc

@@ -2,40 +2,72 @@
 
 Library for Amazon's Flexible Payment Service.
 
-== CONFIGURE
+== INITIALIZE
 
-In config/initializers/amazon_flex_pay.rb, do the following:
+Initialize the gem, probably in config/initializers/amazon_flex_pay.rb (for Rails):
 
   AmazonFlexPay.access_key = 'your access key'
   AmazonFlexPay.secret_key = 'your secret key'
-  AmazonFlexPay.go_live! # if you're done with the sandbox
+  AmazonFlexPay.go_live! if Rails.env.production?
 
-== EXAMPLES
+== CALL
 
-Note that while the examples are shown using Rails methods, the only Rails requirement is ActiveSupport's inflector.
+=== AmazonFlexPay::Pipelines
 
-1. Construct a single-use pipeline for the user. This is where the user will agree to pay a certain amount to a specific recipient.
+Start here. You'll need tokens for API calls. These are generated by users via
+parameterized pipelines.
 
-     pipeline = AmazonFlexPay.single_use_pipeline('mypipeline3292', :recipient_token => 'RTOKEN', :transaction_amount => '12.99')
-     redirect_to pipeline.url('http://example.com/return')
+==== Example
 
-2. Then on the return page, take the sender token and run a Pay request:
+Construct a single-use pipeline for the user. This is where the user will agree
+to pay a certain amount to a specific recipient (maybe you?).
 
-     begin
-       response = AmazonFlexPay.pay('12.99', 'USD', 'STOKEN', 'myrequest3292')
-       flash[:notice] = "Thanks! Your payment is processing."
-     rescue AmazonFlexPay::API::ErrorResponse => e
-       flash[:error] = "Sorry, something went wrong."
-       e.errors.each do |error|
-         # notify yourself about error.code and error.message
-       end
-     end
-     redirect_to product_path
+  redirect_to AmazonFlexPay.single_use_pipeline(
+    'mypipeline3292',
+    'http://example.com/return',
+    :recipient_token => 'RTOKEN',
+    :transaction_amount => '12.99'
+  )
 
-3. Then wait for a IPN to your registered listening URL and check that it's successful.
+=== AmazonFlexPay::API
 
-== LEARN MORE
+With tokens, you can make API calls. Note that results are asynchronous via IPNs.
+Payment and Refund examples are below. You can see all available API methods
+here[https://github.com/kickstarter/amazon_flex_pay/blob/master/lib/amazon_flex_pay/api.rb].
 
-All methods required for integrating API calls and Pipeline requests are found in the AmazonFlexPay module.
+==== Payment Example
 
-Copyright (c) 2012 Kickstarter, released under the MIT license.
+Once you have a sender token, you can attempt to collect.
+
+  begin
+    response = AmazonFlexPay.pay('12.99', 'USD', 'senderToken123')
+    flash[:notice] = "Thanks! Your payment is processing."
+  rescue AmazonFlexPay::API::Error => e
+    flash[:error] = "Sorry, something went wrong."
+    e.errors.each do |error|
+      # notify yourself about error.code and error.message
+    end
+  end
+
+  redirect_to product_path
+
+==== Refund Example
+
+If you would like to give your last order a $10 refund, you can call the refund
+method like this:
+
+  order = Order.last
+
+  AmazonFlexPay.refund(
+    order.transaction_id,
+    order.id,
+    caller_description: 'Friends and family discount.',
+    refund_amount: { value: 10, currency_code: 'USD' },
+  )
+
+Note: In this example, we are using the order id as the caller reference. You
+can pass any reference that you like. Also, the 'caller_description' and
+'refund_amount' options are not required. The default refund amount is the
+original transaction amount.
+
+Copyright (c) 2013 Kickstarter, released under the MIT license.

data/Rakefile

@@ -17,6 +17,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'AmazonFlexPay'
   rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.main     = 'README.rdoc'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/amazon_flex_pay.rb

@@ -19,7 +19,6 @@ require_relative 'amazon_flex_pay/api'
 require_relative 'amazon_flex_pay/pipelines'
 
 module AmazonFlexPay
-  VERSION = '0.10.0'
   API_VERSION = '2011-09-20'
   PIPELINE_VERSION = '2009-01-09'
 

data/lib/amazon_flex_pay/api/base_request.rb

@@ -1,5 +1,5 @@
 module AmazonFlexPay::API #:nodoc:
-  class BaseRequest < AmazonFlexPay::Model
+  class BaseRequest < AmazonFlexPay::Model #:nodoc:
     def to_url
       AmazonFlexPay.api_endpoint + '?' + self.to_param
     end
@@ -27,7 +27,7 @@ module AmazonFlexPay::API #:nodoc:
       self.class.to_s.split('::').last
     end
 
-    class BaseResponse < AmazonFlexPay::Model
+    class BaseResponse < AmazonFlexPay::Model #:nodoc:
       attribute :request
       attribute :request_id
 
@@ -45,7 +45,7 @@ module AmazonFlexPay::API #:nodoc:
       end
     end
 
-    class ErrorResponse < AmazonFlexPay::Model
+    class ErrorResponse < AmazonFlexPay::Model #:nodoc:
       attribute :request_id
 
       def self.from_xml(xml)

data/lib/amazon_flex_pay/pipelines/base.rb

@@ -1,5 +1,5 @@
 module AmazonFlexPay::Pipelines #:nodoc:
-  class Base < AmazonFlexPay::Model
+  class Base < AmazonFlexPay::Model #:nodoc:
     attribute :'returnURL' # required
     attribute :caller_reference # required
     attribute :cobranding_style

data/lib/amazon_flex_pay/version.rb

@@ -0,0 +1,3 @@
+module AmazonFlexPay
+  VERSION = '0.11.0'
+end

data/test/amazon_flex_pay/api_test.rb

@@ -376,12 +376,12 @@ class AmazonFlexPay::APITest < AmazonFlexPay::Test
 
   should "catch and parse errors" do
     net_http_res = stub(:code => 400)
-    http_response = RestClient::Response.create(error_response, net_http_res, nil)
+    request = TestRequest.new(:foo => 'bar')
+    http_response = RestClient::Response.create(error_response, net_http_res, nil, request)
     RestClient.expects(:get).raises(RestClient::BadRequest.new(http_response))
 
     error = nil
     begin
-      request = TestRequest.new(:foo => 'bar')
       AmazonFlexPay.send(:submit, request)
     rescue AmazonFlexPay::API::InvalidParams => e
       error = e
@@ -397,11 +397,11 @@ class AmazonFlexPay::APITest < AmazonFlexPay::Test
 
     ActiveSupport::Notifications.subscribed(callback, "amazon_flex_pay.api") do
       net_http_res = stub(:code => 400)
-      http_response = RestClient::Response.create(error_response, net_http_res, nil)
+      request = TestRequest.new(:foo => 'bar')
+      http_response = RestClient::Response.create(error_response, net_http_res, nil, request)
       RestClient.expects(:get).raises(RestClient::BadRequest.new(http_response))
 
       begin
-        request = TestRequest.new(:foo => 'bar')
         AmazonFlexPay.send(:submit, request)
       rescue AmazonFlexPay::API::Error
       end

data/test/test_helper.rb

@@ -1,19 +1,19 @@
 # load the support libraries
-require 'test/unit'
 require 'rubygems'
-gem 'rails', '3.2.5'
-require 'mocha'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/pride'
+require 'mocha/setup'
+require 'shoulda'
 
 # load the gem
 require_relative '../lib/amazon_flex_pay'
 
 require_relative 'response_samples'
 
-class AmazonFlexPay::Test < Test::Unit::TestCase
-  def default_test; end # quiet Test::Unit
-
-  def self.should(name, &block) # very simple syntax
-    define_method("test_should_#{name.gsub(/[ -]/, '_')}", &block)
+class AmazonFlexPay::Test <  MiniTest::Unit::TestCase
+  def assert_nothing_raised(*)
+    yield
   end
 end
 

metadata

@@ -1,78 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: amazon_flex_pay
 version: !ruby/object:Gem::Version
-  version: 0.10.0
-  prerelease: 
+  version: 0.11.0
 platform: ruby
 authors:
 - Lance Ivy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.14
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.5
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: A straight-forward REST API for Amazon's Flexible Payments Services.
@@ -81,6 +128,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/amazon_flex_pay.rb
+- lib/amazon_flex_pay/api.rb
 - lib/amazon_flex_pay/api/base_request.rb
 - lib/amazon_flex_pay/api/cancel.rb
 - lib/amazon_flex_pay/api/cancel_token.rb
@@ -98,22 +150,18 @@ files:
 - lib/amazon_flex_pay/api/reserve.rb
 - lib/amazon_flex_pay/api/settle.rb
 - lib/amazon_flex_pay/api/verify_signature.rb
-- lib/amazon_flex_pay/api.rb
 - lib/amazon_flex_pay/data_types.rb
 - lib/amazon_flex_pay/enumerations.rb
 - lib/amazon_flex_pay/model.rb
+- lib/amazon_flex_pay/pipelines.rb
 - lib/amazon_flex_pay/pipelines/base.rb
 - lib/amazon_flex_pay/pipelines/edit_token.rb
 - lib/amazon_flex_pay/pipelines/multi_use.rb
 - lib/amazon_flex_pay/pipelines/recipient.rb
 - lib/amazon_flex_pay/pipelines/single_use.rb
-- lib/amazon_flex_pay/pipelines.rb
 - lib/amazon_flex_pay/signature.rb
 - lib/amazon_flex_pay/util.rb
-- lib/amazon_flex_pay.rb
-- LICENSE
-- README.rdoc
-- Rakefile
+- lib/amazon_flex_pay/version.rb
 - test/amazon_flex_pay/api/base_request_test.rb
 - test/amazon_flex_pay/api_test.rb
 - test/amazon_flex_pay/data_types_test.rb
@@ -125,27 +173,26 @@ files:
 - test/test_helper.rb
 homepage: http://github.com/kickstarter/amazon_flex_pay
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: API layer for Amazon FPS
 test_files:
 - test/amazon_flex_pay/api/base_request_test.rb
@@ -157,4 +204,3 @@ test_files:
 - test/amazon_flex_pay/util_test.rb
 - test/response_samples.rb
 - test/test_helper.rb
-has_rdoc: