promise_pay 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9e7dfe46629cfaf5b0884f40833abf5c0d7baef
-  data.tar.gz: c327448d515a250de8d6ab1117e22e1a673ccb16
+  metadata.gz: b3aff87096dc525f1caa87ff5dcdc139b60639a6
+  data.tar.gz: c43eeca819612307e63e294aa31559ab6c3c30dc
 SHA512:
-  metadata.gz: c48a5a6777115fc93be86ef26506ef5b1cec25c59f829b0785ea51d57664bec3147c351c3ac651035430cbbb6bf916982b258e76402047eebfdeba8ce87b2c9b
-  data.tar.gz: 3d4261aca5c66d852ad3fccd915a3cebff3083264f3758e04ed59fd82d3e48bc7766cddc5f64ffe51f72bcfa5fa7790463966c258a0d9939690ff387b9e3d348
+  metadata.gz: a27f02557a1b4979866f6ff0838cb2a931dda180863ba13bc265130a1da173097ef1c4adc1c8386822561522e86024023b35bacec69afcf73059c867c12f0538
+  data.tar.gz: 6ba2e1df0596322db41773e7dffd7980fd6fa7bfe421c254b5cda399f10a0842f362513a310ee018e3fabe5805d31309c3259fae9388a439136406e53b3d0f7d

data/README.md

@@ -22,10 +22,6 @@ Generate your PromizePay API key and the rails promise_pay initializer:
 
     $ rails generate promise_pay:init EMAIL PASSWORD
 
-Set your fee-ids from PromisePay in config `config/initializers/promise_pay.rb`:
-
-    PromisePay.fee_ids = "abc-123"
-
 You're set to go!
 
 ## Extra Info
@@ -42,6 +38,8 @@ Note this will overwrite anything in `config/initializers/promise_pay.rb`, but y
 
 ## Usage
 
+All API interations, and therefore all params for these classes can be viewed at the official PromisePay doc website (http://docs.promisepay.com/).
+
 ```ruby
 # A new PromisePay::Session that generates a session token
 session = PromisePay::Session.new(session_params)
@@ -58,6 +56,10 @@ user.email    => "email@addr"
 item = PromisePay::Item.find("1s345")
 item.amount   => 10
 
+# Create a fee returning a PromisePay::Feelist object
+fee = PromisePay::Feelst.create(fee_params)
+fee.id        => "5c07f36a-d18f-4153-9a75-ebf9f4f2f9ef"
+
 ```
 
 ## Contributing

data/lib/generators/templates/promise_pay_initializer.rb

@@ -3,4 +3,3 @@ require "promise_pay"
 PromisePay.api_user = "<%= email %>"
 PromisePay.api_key  = "<%= token %>"
 PromisePay.env      = :<%= env %>
-PromisePay.fee_ids  = ""

data/lib/promise_pay/feelist.rb

@@ -0,0 +1,67 @@
+require "promise_pay/lib/dynamic_accessors"
+require "json"
+
+module PromisePay
+  class Feelist
+    include Lib::DynamicAccessors
+
+    attr_reader :id
+    attr_reader :name
+    attr_reader :fee_type_id
+    attr_reader :amount
+    attr_reader :cap
+    attr_reader :min
+    attr_reader :max
+    attr_reader :to
+
+    def self.create(options = {})
+      new(options).create
+    end
+
+    def initialize(options = {})
+      @name         = options.fetch(:name)
+      @fee_type_id  = options.fetch(:fee_type_id)
+      @amount       = options.fetch(:amount)
+      @cap          = options.fetch(:cap)
+      @min          = options.fetch(:min)
+      @max          = options.fetch(:max)
+      @to           = options.fetch(:to)
+
+      assign_instance_variables({'feelist' => options})
+    end
+
+    def create
+      assign_instance_variables(resource_result)
+      self
+    end
+
+    private
+
+    def resource_result
+      request = PromisePay::Request.new(
+        path: api_resource,
+        method: :post,
+        payload: payload
+      )
+
+      response = request.execute
+      JSON.parse(response)["feelist"]
+    end
+
+    def api_resource
+      "feelist"
+    end
+
+    def payload
+      {
+        name:         name,
+        fee_type_id:  fee_type_id,
+        amount:       amount,
+        cap:          cap,
+        min:          min,
+        max:          max,
+        to:           to
+      }
+    end
+  end
+end

data/lib/promise_pay/item.rb

@@ -3,11 +3,14 @@ require "json"
 
 module PromisePay
   class Item
+    include Lib::DynamicAccessors
+
     attr_reader :id
 
     def initialize(id = nil, options = {})
       @id = id
-      assign_instance_variables({'item' => options}) unless options.empty?
+
+      assign_instance_variables({'item' => options})
     end
 
     class << self
@@ -42,31 +45,5 @@ module PromisePay
     def api_resource
       "items/#{id}"
     end
-
-    def assign_instance_variables(result)
-      result.each do |attribute, value|
-        if value.is_a?(Hash)
-          value.each { |att, val| initialize_property(att, val) }
-        else
-          initialize_property(attribute, value)
-        end
-      end
-      self
-    end
-
-    def initialize_property(attribute, value)
-      attribute = attribute.gsub(/s$/, '_id') if ["buyers","sellers"].include? attribute
-      Lib::DynamicAccessors.define_accessor(attribute, value, self) unless accessor_defined?(attribute)
-      set_property(attribute, value)
-    end
-
-    def accessor_defined?(attribute)
-      respond_to?(attribute) && respond_to?("#{attribute}=")
-    end
-
-    def set_property(attribute, value)
-      setter_method = "#{attribute}="
-      self.send(setter_method, value)
-    end
   end
 end

data/lib/promise_pay/lib/dynamic_accessors.rb

@@ -1,41 +1,67 @@
 module PromisePay
   module Lib
     module DynamicAccessors
-      class << self
-        def define_accessor(attribute, value, object)
-          klass = object.class
-          if attribute.to_s.end_with? "_at"
-            define_date_based_accessors(attribute, value, klass)
+      def assign_instance_variables(result)
+        return if result.empty?
+
+        result.each do |attribute, value|
+          if value.is_a?(Hash)
+            value.each { |att, val| initialize_property(att, val) }
           else
-            define_standard_accessors(attribute, value, klass)
+            initialize_property(attribute, value)
           end
         end
+        self
+      end
+
+      def initialize_property(attribute, value)
+        attribute = attribute.gsub(/s$/, '_id') if ["buyers","sellers"].include? attribute
+        define_accessor(attribute, value, self) unless accessor_defined?(attribute)
+        set_property(attribute, value)
+      end
 
-        private
+      def accessor_defined?(attribute)
+        respond_to?(attribute) && respond_to?("#{attribute}=")
+      end
 
-        def define_date_based_accessors(attribute, value, klass)
-          klass.class_eval %Q"
-            def #{attribute}=(value)
-              @#{attribute} = value.nil? ? nil : Time.parse(value).to_i
-            end
+      def set_property(attribute, value)
+        setter_method = "#{attribute}="
+        self.send(setter_method, value)
+      end
 
-            def #{attribute}
-              @#{attribute}.nil? ? nil : Time.at(@#{attribute})
-            end
-          "
+      def define_accessor(attribute, value, object)
+        klass = object.class
+        if attribute.to_s.end_with? "_at"
+          define_date_based_accessors(attribute, value, klass)
+        else
+          define_standard_accessors(attribute, value, klass)
         end
+      end
 
-        def define_standard_accessors(attribute, value, klass)
-          klass.class_eval %Q"
-            def #{attribute}=(value)
-              @#{attribute} = value
-            end
+      private
 
-            def #{attribute}
-              @#{attribute}
-            end
-          "
-        end
+      def define_date_based_accessors(attribute, value, klass)
+        klass.class_eval %Q"
+          def #{attribute}=(value)
+            @#{attribute} = value.nil? ? nil : Time.parse(value).to_i
+          end
+
+          def #{attribute}
+            @#{attribute}.nil? ? nil : Time.at(@#{attribute})
+          end
+        "
+      end
+
+      def define_standard_accessors(attribute, value, klass)
+        klass.class_eval %Q"
+          def #{attribute}=(value)
+            @#{attribute} = value
+          end
+
+          def #{attribute}
+            @#{attribute}
+          end
+        "
       end
     end
   end

data/lib/promise_pay/marketplace.rb

@@ -6,8 +6,8 @@ module PromisePay
     attr_reader :token
 
     def initialize(options = {})
-      @user     = options.fetch :user
-      @password = options.fetch :password
+      @user     = options.fetch(:user)
+      @password = options.fetch(:password)
     end
 
     def request_token

data/lib/promise_pay/request.rb

@@ -4,9 +4,11 @@ module PromisePay
   class Request
 
     def initialize(options = {})
-      @path     = options.fetch :path
-      @user     = options.fetch :user,          PromisePay.api_user
-      @password = options.fetch :password,      PromisePay.api_key
+      @path     = options.fetch(:path)
+      @user     = options.fetch(:user)      { PromisePay.api_user }
+      @password = options.fetch(:password)  { PromisePay.api_key }
+      @method   = options.fetch(:method)    { :get }
+      @payload  = options.fetch(:payload)   { nil }
       @request  = build_request
     end
 
@@ -23,13 +25,18 @@ module PromisePay
     private
 
     def build_request
-      RestClient::Request.new(
-        method:   :get,
+      RestClient::Request.new(request_params)
+    end
+
+    def request_params
+      {
+        method:   method,
         url:      endpoint,
         user:     user,
         password: password,
+        payload:  payload,
         headers:  { accept: :json, content_type: :json }
-      )
+      }
     end
 
     def endpoint
@@ -47,6 +54,8 @@ module PromisePay
     attr_reader :path
     attr_reader :user
     attr_reader :password
+    attr_reader :method
+    attr_reader :payload
     attr_reader :request
   end
 

data/lib/promise_pay/session.rb

@@ -23,22 +23,22 @@ module PromisePay
     attr_accessor :buyer_country
 
     def initialize(options = {})
-      @current_user_id    = options.fetch :current_user_id,     nil
-      @item_name          = options.fetch :item_name,           nil
-      @amount             = options.fetch :amount,              nil
-      @seller_lastname    = options.fetch :seller_lastname,     nil
-      @seller_firstname   = options.fetch :seller_firstname,    nil
-      @buyer_lastname     = options.fetch :buyer_lastname,      nil
-      @buyer_firstname    = options.fetch :buyer_firstname,     nil
-      @seller_email       = options.fetch :seller_email,        nil
-      @buyer_email        = options.fetch :buyer_email,         nil
-      @external_item_id   = options.fetch :external_item_id,    nil
-      @external_seller_id = options.fetch :external_seller_id,  nil
-      @external_buyer_id  = options.fetch :external_buyer_id,   nil
-      @fee_ids            = options.fetch :fee_ids,             nil
-      @payment_type_id    = options.fetch :payment_type_id,     nil
-      @seller_country     = options.fetch :seller_country,      nil
-      @buyer_country      = options.fetch :buyer_country,       nil
+      @current_user_id    = options.fetch(:current_user_id)     { nil }
+      @item_name          = options.fetch(:item_name)           { nil }
+      @amount             = options.fetch(:amount)              { nil }
+      @seller_lastname    = options.fetch(:seller_lastname)     { nil }
+      @seller_firstname   = options.fetch(:seller_firstname)    { nil }
+      @buyer_lastname     = options.fetch(:buyer_lastname)      { nil }
+      @buyer_firstname    = options.fetch(:buyer_firstname)     { nil }
+      @seller_email       = options.fetch(:seller_email)        { nil }
+      @buyer_email        = options.fetch(:buyer_email)         { nil }
+      @external_item_id   = options.fetch(:external_item_id)    { nil }
+      @external_seller_id = options.fetch(:external_seller_id)  { nil }
+      @external_buyer_id  = options.fetch(:external_buyer_id)   { nil }
+      @fee_ids            = options.fetch(:fee_ids)             { nil }
+      @payment_type_id    = options.fetch(:payment_type_id)     { nil }
+      @seller_country     = options.fetch(:seller_country)      { nil }
+      @buyer_country      = options.fetch(:buyer_country)       { nil }
     end
 
     def request_token

data/lib/promise_pay/user.rb

@@ -3,11 +3,14 @@ require "json"
 
 module PromisePay
   class User
+    include Lib::DynamicAccessors
+
     attr_reader :id
 
     def initialize(id = nil, options = {})
       @id = id
-      assign_instance_variables({'user' => options}) unless options.empty?
+
+      assign_instance_variables({'user' => options})
     end
 
     class << self
@@ -42,26 +45,5 @@ module PromisePay
     def api_resource
       "users/#{id}"
     end
-
-    def assign_instance_variables(result)
-      result["user"].each do |attribute, value|
-        initialize_property(attribute, value)
-      end
-      self
-    end
-
-    def initialize_property(attribute, value)
-      Lib::DynamicAccessors.define_accessor(attribute, value, self) unless accessor_defined?(attribute)
-      set_property(attribute, value)
-    end
-
-    def accessor_defined?(attribute)
-      respond_to?(attribute) && respond_to?("#{attribute}=")
-    end
-
-    def set_property(attribute, value)
-      setter_method = "#{attribute}="
-      self.send(setter_method, value)
-    end
   end
 end

data/lib/promise_pay/version.rb

@@ -1,3 +1,3 @@
 module PromisePay
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/promise_pay.rb

@@ -3,6 +3,7 @@ require "promise_pay/marketplace"
 require "promise_pay/request"
 require "promise_pay/session"
 require "promise_pay/user"
+require "promise_pay/feelist"
 require "promise_pay/version"
 require "promise_pay/collection"
 require "promise_pay/country"
@@ -15,7 +16,6 @@ module PromisePay
     attr_accessor :api_user
     attr_accessor :api_key
     attr_accessor :env
-    attr_accessor :fee_ids
   end
 
   class InvalidRequest < StandardError; end

data/spec/promise_pay/feelist_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+
+describe PromisePay::Feelist do
+  let(:request) { double("PromisePay::Request", execute: sample_response) }
+
+  before do
+    allow(PromisePay::Request).to receive(:new) { request }
+  end
+
+  describe ".create" do
+    let(:sample_response) { File.read("./spec/support/fixtures/feelist/create.json") }
+
+    let(:params) do
+      {
+        name:         "Transaction fee",
+        fee_type_id:  1,
+        amount:       1500,
+        cap:          nil,
+        min:          nil,
+        max:          nil,
+        to:           'seller'
+      }
+    end
+
+    it "returns a PromisePay::Feelist object" do
+      expect(described_class.create(params)).to be_a_kind_of PromisePay::Feelist
+    end
+
+    it "PromisePay::Feelist has correctly assigned attributes" do
+      promise_pay_fee = described_class.create(params)
+
+      expect(promise_pay_fee.id).to eq "5c07f36a-d18f-4153-9a75-ebf9f4f2f9ef"
+      expect(promise_pay_fee.name).to eq "Transaction fee"
+      expect(promise_pay_fee.fee_type_id).to eq 1
+      expect(promise_pay_fee.amount).to eq 1500
+      expect(promise_pay_fee.cap).to eq nil
+      expect(promise_pay_fee.min).to eq nil
+      expect(promise_pay_fee.max).to eq nil
+      expect(promise_pay_fee.to).to eq 'seller'
+    end
+
+    it "instantiates PromisePay::Request with the correct path" do
+      expect(PromisePay::Request).
+        to receive(:new).
+        with(hash_including(path: 'feelist'))
+
+      described_class.create(params)
+    end
+
+    it "instantiates PromisePay::Request with the correct method" do
+      expect(PromisePay::Request).
+        to receive(:new).
+        with(hash_including(method: :post))
+
+      described_class.create(params)
+    end
+
+    it "instantiates PromisePay::Request with the correct payload" do
+      expect(PromisePay::Request).
+        to receive(:new).
+        with(hash_including(payload: params))
+
+      described_class.create(params)
+    end
+  end
+end

data/spec/promise_pay/item_spec.rb

@@ -4,7 +4,7 @@ describe PromisePay::Item do
   let(:request) { double("PromisePay::Request", execute: sample_response) }
 
   before do
-    PromisePay::Request.stub(:new) { request }
+    allow(PromisePay::Request).to receive(:new) { request }
   end
 
   describe ".find" do
@@ -31,7 +31,7 @@ describe PromisePay::Item do
 
     it "instantiates PromisePay::Request with the correct path" do
       valid_path = "items/#{item_id}"
-      PromisePay::Request.should_receive(:new).with(path: valid_path)
+      expect(PromisePay::Request).to receive(:new).with(path: valid_path)
       described_class.find(item_id)
     end
   end
@@ -54,7 +54,7 @@ describe PromisePay::Item do
 
     it "instantiates PromisePay::Request with the correct path" do
       valid_path = "items/"
-      PromisePay::Request.should_receive(:new).with(path: valid_path)
+      expect(PromisePay::Request).to receive(:new).with(path: valid_path)
       described_class.find_all
     end
   end

data/spec/promise_pay/marketplace_spec.rb

@@ -9,13 +9,13 @@ describe PromisePay::Marketplace do
     let(:password)        { "password" }
 
     before do
-      PromisePay::Request.stub(:new) { request }
+      allow(PromisePay::Request).to receive(:new) { request }
     end
 
     it "instantiates PromisePay::Request with the correct path" do
       valid_path = "request_token"
 
-      PromisePay::Request.should_receive(:new).with(
+      expect(PromisePay::Request).to receive(:new).with(
         path:     valid_path,
         user:     user,
         password: password
@@ -25,7 +25,7 @@ describe PromisePay::Marketplace do
     end
 
     it "returns the generated marketplace token" do
-      described_class.new(user: user, password: password).request_token.should eq("123abc")
+      expect(described_class.new(user: user, password: password).request_token).to eq("123abc")
     end
   end
 end

data/spec/promise_pay/request_spec.rb

@@ -18,31 +18,48 @@ describe PromisePay::Request do
       expect(request).to be_an_instance_of PromisePay::Request
     end
 
-    it "uses the test api when configured" do
-      expect { PromisePay.env = :test }.
-        to change { request.send(:endpoint).start_with? PromisePay::TEST_HOST }.
-        from(false).to(true)
-    end
-
     it "builds a RestClient::Request" do
       expect(request.send(:request)).to be_an_instance_of RestClient::Request
     end
+
+    it "uses the test api endpoint when configured" do
+      PromisePay.env = :test
+
+      request_endpoint = request.send(:endpoint)
+      expect(request_endpoint.start_with?(PromisePay::TEST_HOST)).to eq(true)
+    end
+
+    it "uses the production api endpoint when configured" do
+      PromisePay.env = :production
+
+      request_endpoint = request.send(:endpoint)
+      expect(request_endpoint.start_with?(PromisePay::API_HOST)).to eq(true)
+    end
+
+    it "takes on optional request method arguement" do
+      request = described_class.new(path: "users/", method: :post)
+      expect(request.send(:method)).to eq(:post)
+    end
   end
 
   describe "#execute" do
     it "calls the RestClient::Request to be exectued" do
       rest_client_request = request.send(:request)
-      rest_client_request.should_receive(:execute)
+      expect(rest_client_request).to receive(:execute)
       request.execute
     end
 
     it "re-raises RestClient::Unauthorized exceptions" do
-      RestClient::Request.any_instance.stub(:execute) { raise RestClient::Unauthorized }
+      rest_client_request = request.send(:request)
+      allow(rest_client_request).to receive(:execute) { raise RestClient::Unauthorized }
+
       expect { request.execute }.to raise_error PromisePay::RequestError
     end
 
     it "re-raises RestClient::BadRequest exceptions" do
-      RestClient::Request.any_instance.stub(:execute) { raise RestClient::BadRequest }
+      rest_client_request = request.send(:request)
+      allow(rest_client_request).to receive(:execute) { raise RestClient::BadRequest }
+
       expect { request.execute }.to raise_error PromisePay::RequestError
     end
 

data/spec/promise_pay/session_spec.rb

@@ -28,7 +28,7 @@ describe PromisePay::Session do
 
     context "with valid params" do
       before do
-        PromisePay::Request.stub(:new) { request }
+        allow(PromisePay::Request).to receive(:new) { request }
       end
 
       it "returns the generated session token from PromisePay" do
@@ -42,7 +42,7 @@ describe PromisePay::Session do
 
       it "instantiates PromisePay::Request with the correct path" do
         valid_path = "request_session_token?#{valid_params.to_param}"
-        PromisePay::Request.should_receive(:new).with(path: valid_path)
+        expect(PromisePay::Request).to receive(:new).with(path: valid_path)
         session.request_token
       end
     end

data/spec/promise_pay/user_spec.rb

@@ -4,7 +4,7 @@ describe PromisePay::User do
   let(:request) { double("PromisePay::Request", execute: sample_response) }
 
   before do
-    PromisePay::Request.stub(:new) { request }
+    allow(PromisePay::Request).to receive(:new) { request }
   end
 
   describe ".find" do
@@ -30,7 +30,7 @@ describe PromisePay::User do
 
     it "instantiates PromisePay::Request with the correct path" do
       valid_path = "users/#{user_id}"
-      PromisePay::Request.should_receive(:new).with(path: valid_path)
+      expect(PromisePay::Request).to receive(:new).with(path: valid_path)
       described_class.find(user_id)
     end
   end
@@ -53,7 +53,7 @@ describe PromisePay::User do
 
     it "instantiates PromisePay::Request with the correct path" do
       valid_path = "users/"
-      PromisePay::Request.should_receive(:new).with(path: valid_path)
+      expect(PromisePay::Request).to receive(:new).with(path: valid_path)
       described_class.find_all
     end
   end

data/spec/spec_helper.rb

@@ -4,3 +4,4 @@ require "promise_pay/marketplace"
 require "promise_pay/request"
 require "promise_pay/session"
 require "promise_pay/user"
+require "promise_pay/feelist"

data/spec/support/fixtures/feelist/create.json

@@ -0,0 +1,14 @@
+{
+  "feelist": {
+    "uuid": "5c07f36a-d18f-4153-9a75-ebf9f4f2f9ef",
+    "name": "Transaction fee",
+    "fee_type_id": 1,
+    "amount": 1500,
+    "cap": null,
+    "min": null,
+    "max": null,
+    "to": "seller",
+    "id": "5c07f36a-d18f-4153-9a75-ebf9f4f2f9ef",
+    "href": "/feelist/5c07f36a-d18f-4153-9a75-ebf9f4f2f9ef"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promise_pay
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Liam Norton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,6 +112,7 @@ files:
 - lib/promise_pay.rb
 - lib/promise_pay/collection.rb
 - lib/promise_pay/country.rb
+- lib/promise_pay/feelist.rb
 - lib/promise_pay/item.rb
 - lib/promise_pay/lib/dynamic_accessors.rb
 - lib/promise_pay/marketplace.rb
@@ -121,12 +122,14 @@ files:
 - lib/promise_pay/version.rb
 - promise_pay.gemspec
 - spec/promise_pay/country_spec.rb
+- spec/promise_pay/feelist_spec.rb
 - spec/promise_pay/item_spec.rb
 - spec/promise_pay/marketplace_spec.rb
 - spec/promise_pay/request_spec.rb
 - spec/promise_pay/session_spec.rb
 - spec/promise_pay/user_spec.rb
 - spec/spec_helper.rb
+- spec/support/fixtures/feelist/create.json
 - spec/support/fixtures/item/find.json
 - spec/support/fixtures/item/find_all.json
 - spec/support/fixtures/token_generation.json
@@ -158,12 +161,14 @@ specification_version: 4
 summary: PromisePay gem
 test_files:
 - spec/promise_pay/country_spec.rb
+- spec/promise_pay/feelist_spec.rb
 - spec/promise_pay/item_spec.rb
 - spec/promise_pay/marketplace_spec.rb
 - spec/promise_pay/request_spec.rb
 - spec/promise_pay/session_spec.rb
 - spec/promise_pay/user_spec.rb
 - spec/spec_helper.rb
+- spec/support/fixtures/feelist/create.json
 - spec/support/fixtures/item/find.json
 - spec/support/fixtures/item/find_all.json
 - spec/support/fixtures/token_generation.json