promise_pay 0.1.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1d35eed99d87f83d0cec327486a4a156db10b28
-  data.tar.gz: 670c40d18597dc5da5b66f76682db51cdf28e962
+  metadata.gz: 57fc2674df1d8d9b170ee3f7d3f789d4b18d5ab3
+  data.tar.gz: 870f85879f4435dc5dd2434848d52f2ca24feeed
 SHA512:
-  metadata.gz: c40c8c221466c173af2a14195e843c2ec65c539578ceec3b6128b401bb4d6957b964e966c174b4a3b51fd7f2179b867e51acee8bfede3779ab4444ce5ff77e9c
-  data.tar.gz: 50d45d6f1018a1281cef90c6a5b22f998ed5a08cf35480284a7c8688f8d6574c415a6c727f8c0d190039bd418b76826bec46c79162f9a2e2744f29c282504ece
+  metadata.gz: 7a247db1fb8d3b364c8ab00f1d36f4cce6e09c3963ef4e65580361be65b28c6f0de20cafc460fa93d0a4641852f658f2190ba3728ba04b024d66c629a702a227
+  data.tar.gz: 456f02b71098d500830807274389a13ebeb7fb44a2367aef38060c25bd3720233efd5ab5ff08e18a0c08835249445481d309a0f4ce5b6dec377dfe3e1c91c2d3

data/.travis.yml

@@ -1,8 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.1
-  - 2.1.3
-  - 2.1.5
-  - 2.2.2
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+### head
+
+* Add /callbacks POST endpoint for creating callbacks [[#10](https://github.com/iamliamnorton/promise_pay/pull/10)]
+* PromisePay::Item initializer refactor for cleaner instantiation [[#10](https://github.com/iamliamnorton/promise_pay/pull/10)]

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in promise_pay.gemspec
 gemspec

data/README.md

@@ -28,7 +28,7 @@ You're set to go!
 
 To use PromisePay's test API, set the following in `config/initializers/promise_pay.rb`:
 
-    PromisePay.env = :test
+    PromisePay.env = :test # probaby should reference config/environments/...
 
 Along with your test environments api user/key. You can generate all this by running:
 
@@ -53,7 +53,7 @@ user = PromisePay::User.find(12345)
 user.email    => "email@addr"
 
 # Query for a status of an item (abc123) returning a PromisePay::Item::Status object
-user = PromisePay::Item::Status.find('abc123')
+user = PromisePay::ItemStatus.find('abc123')
 user.state    => "pending"
 
 # Query PromisePay for an item (1s345) returning a PromisePay::Item object
@@ -61,16 +61,25 @@ item = PromisePay::Item.find("1s345")
 item.amount   => 10
 # Note: this is a slow operation, it you just want item status use the Item::Status API
 
+# New PromisePay::Item using params hash for attributes
+item = PromisePay::Item.new({id: "1s345"})
+item.id   => "1s345"
+
 # Create a fee returning a PromisePay::Feelist object
 fee = PromisePay::Feelist.create(fee_params)
 fee.id        => "5c07f36a-d18f-4153-9a75-ebf9f4f2f9ef"
 
+# Create a callback
+fee = PromisePay::Callback.create(url: "https://our.api/callback", object_type: "items")
+fee.id        => "77e4fc66-b695-4e72-90ac-b454c395b867"
+
 ```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/promise_pay/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+This project follows [semantic versioning](http://semver.org).
+
+In order to make a change, do so from a feature branch and pull request the
+project. Your pull request should not include a version change. Instead, make
+an addition to the "head" version in the CHANGELOG that briefly describes the
+change and ideally links to the pull request.

data/lib/promise_pay/callback.rb

@@ -0,0 +1,74 @@
+require "promise_pay/lib/dynamic_accessors"
+require "json"
+
+module PromisePay
+  class Callback
+    include Lib::DynamicAccessors
+
+    ENDPOINT = 'callbacks/'
+
+    attr_reader :id
+    attr_reader :url
+    attr_reader :description
+    attr_reader :object_type
+    attr_reader :enabled
+
+    attr_reader :method
+    attr_reader :endpoint
+
+    def self.index(options = {})
+      new(options.merge(method: :get)).execute
+    end
+
+    def self.delete(options = {})
+      new(options.merge(method: :delete)).execute
+    end
+
+    def self.create(options = {})
+      new(options.merge(method: :post)).execute
+    end
+
+    def initialize(options = {})
+      @id           = options.fetch(:id) { nil }
+      @url          = options.fetch(:url) { "" }
+      @description  = options.fetch(:description) { "" }
+      @object_type  = options.fetch(:object_type) { "" }
+      @enabled      = options.fetch(:enabled) { true }
+
+      @method       = options.fetch(:method)
+      @endpoint     = ENDPOINT + @id.to_s
+    end
+
+    def execute
+      assign_instance_variables(result)
+      self
+    end
+
+    private
+
+    def result
+      JSON.parse(response)
+    end
+
+    def response
+      request.execute
+    end
+
+    def request
+      PromisePay::Request.new(
+        path: endpoint,
+        method: method,
+        payload: payload
+      )
+    end
+
+    def payload
+      {
+        description:  description,
+        enabled:      enabled,
+        object_type:  object_type,
+        url:          url,
+      }
+    end
+  end
+end

data/lib/promise_pay/item.rb

@@ -7,15 +7,14 @@ module PromisePay
 
     attr_reader :id
 
-    def initialize(id = nil, options = {})
-      @id = id
-
+    def initialize(options = {})
+      @id = options[:id]
       assign_instance_variables({'item' => options})
     end
 
     class << self
       def find(id)
-        new(id).find
+        new(id: id).find
       end
 
       def find_all
@@ -30,7 +29,7 @@ module PromisePay
 
     def find_all
       resource_result.map do |result|
-        self.class.new(nil, result)
+        self.class.new(result)
       end
     end
 

data/lib/promise_pay/version.rb

@@ -1,3 +1,3 @@
 module PromisePay
-  VERSION = "0.1.10"
+  VERSION = "0.2.0"
 end

data/lib/promise_pay.rb

@@ -1,3 +1,4 @@
+require "promise_pay/callback"
 require "promise_pay/item"
 require "promise_pay/marketplace"
 require "promise_pay/request"

data/promise_pay.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Liam Norton"]
   spec.email         = ["liam.norton@flippa.com"]
   spec.summary       = %q{PromisePay gem}
-  spec.description   = %q{PromisePay gem for API calls wrapped in Ruby}
+  spec.description   = %q{PromisePay gem for API calls}
   spec.homepage      = "https://github.com/iamliamnorton/promise_pay"
   spec.license       = "MIT"
 
@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rspec", "~> 3.4"
 
-  spec.add_runtime_dependency "activesupport", ">= 2.3"
-  spec.add_runtime_dependency "json"
-  spec.add_runtime_dependency "rest-client", "~> 1.7"
+  spec.add_runtime_dependency "activesupport", "~> 3.2"
+  spec.add_runtime_dependency "json", "~> 1.7"
+  spec.add_runtime_dependency "rest-client", "~> 1.8"
 end

data/spec/promise_pay/callback_spec.rb

@@ -0,0 +1,116 @@
+require "spec_helper"
+
+describe PromisePay::Callback do
+  let(:request) { double("PromisePay::Request", execute: sample_response) }
+
+  before { allow(PromisePay::Request).to receive(:new).and_return(request) }
+
+  describe ".index" do
+    let(:sample_response) { File.read("./spec/support/fixtures/callback/index.json") }
+
+    it "PromisePay::Callback has correctly assigned attributes" do
+      promise_pay_callback = described_class.index
+
+      expect(promise_pay_callback.callbacks).not_to eq(nil)
+    end
+
+    it "instantiates PromisePay::Request with the correct path" do
+      expect(PromisePay::Request).
+        to receive(:new).
+        with(hash_including(path: PromisePay::Callback::ENDPOINT))
+
+      described_class.index
+    end
+
+    it "instantiates PromisePay::Request with the correct method" do
+      expect(PromisePay::Request).
+        to receive(:new).
+        with(hash_including(method: :get))
+
+      described_class.index
+    end
+  end
+
+  describe ".create" do
+    let(:sample_response) { File.read("./spec/support/fixtures/callback/create.json") }
+
+    let(:params) do
+      {
+        description:  "Our callback endpoint",
+        enabled:      true,
+        object_type:  "items",
+        url:          "https://foo.bar/baz",
+      }
+    end
+
+    it "PromisePay::Callback has correctly assigned attributes" do
+      promise_pay_callback = described_class.create(params)
+
+      aggregate_failures do
+        expect(promise_pay_callback.id).to eq("77e4fc66-b695-4e72-90ac-b454c395b867")
+        expect(promise_pay_callback.description).to eq("Our callback endpoint")
+        expect(promise_pay_callback.enabled).to eq(true)
+        expect(promise_pay_callback.object_type).to eq("items")
+        expect(promise_pay_callback.url).to eq("https://foo.bar/baz")
+      end
+    end
+
+    it "instantiates PromisePay::Request with the correct path" do
+      expect(PromisePay::Request).
+        to receive(:new).
+        with(hash_including(path: PromisePay::Callback::ENDPOINT))
+
+      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
+
+  describe ".delete" do
+    let(:sample_response) { File.read("./spec/support/fixtures/callback/delete.json") }
+
+    let(:params) do
+      { id: "77e4fc66-b695-4e72-90ac-b454c395b867" }
+    end
+
+    it "PromisePay::Callback has correctly assigned attributes" do
+      promise_pay_callback = described_class.delete(params)
+
+      expect(promise_pay_callback.id).to eq("77e4fc66-b695-4e72-90ac-b454c395b867")
+    end
+
+    it "instantiates PromisePay::Request with the correct path" do
+      expect(PromisePay::Request).
+        to receive(:new).
+        with(
+          hash_including(
+            path: PromisePay::Callback::ENDPOINT + "77e4fc66-b695-4e72-90ac-b454c395b867"
+          )
+        )
+
+      described_class.delete(params)
+    end
+
+    it "instantiates PromisePay::Request with the correct method" do
+      expect(PromisePay::Request).
+        to receive(:new).
+        with(hash_including(method: :delete))
+
+      described_class.delete(params)
+    end
+  end
+end

data/spec/promise_pay/item_spec.rb

@@ -17,21 +17,28 @@ describe PromisePay::Item do
 
     it "returned object has correctly assigned attributes" do
       promise_pay_item = described_class.find(item_id)
-      expect(promise_pay_item.id).to eq "wef9834tg"
-      expect(promise_pay_item.name).to eq "ItemName"
-      expect(promise_pay_item.amount).to eq 10
-      expect(promise_pay_item.state).to eq "pending"
+
+      aggregate_failures do
+        expect(promise_pay_item.id).to eq "wef9834tg"
+        expect(promise_pay_item.name).to eq "ItemName"
+        expect(promise_pay_item.amount).to eq 10
+        expect(promise_pay_item.state).to eq "pending"
+      end
     end
 
     it "formats created_at and updated_at as Time" do
       promise_pay_item = described_class.find(item_id)
-      expect(promise_pay_item.created_at).to be_a_kind_of Time
-      expect(promise_pay_item.updated_at).to be_a_kind_of Time
+
+      aggregate_failures do
+        expect(promise_pay_item.created_at).to be_a_kind_of Time
+        expect(promise_pay_item.updated_at).to be_a_kind_of Time
+      end
     end
 
     it "instantiates PromisePay::Request with the correct path" do
       valid_path = "items/#{item_id}"
       expect(PromisePay::Request).to receive(:new).with(path: valid_path)
+
       described_class.find(item_id)
     end
   end
@@ -41,20 +48,27 @@ describe PromisePay::Item do
 
     it "returns an array of PromisePay::Item objects" do
       result = described_class.find_all
-      expect(result).to be_a_kind_of Array
-      expect(result.first).to be_a_kind_of PromisePay::Item
+
+      aggregate_failures do
+        expect(result).to be_a_kind_of Array
+        expect(result.first).to be_a_kind_of PromisePay::Item
+      end
     end
 
     it "returned objects have correctly assigned attributes" do
       promise_pay_user = described_class.find_all.first
-      expect(promise_pay_user.id).to eq "wef9834tg"
-      expect(promise_pay_user.name).to eq "ItemName"
-      expect(promise_pay_user.amount).to eq 10
+
+      aggregate_failures do
+        expect(promise_pay_user.id).to eq "wef9834tg"
+        expect(promise_pay_user.name).to eq "ItemName"
+        expect(promise_pay_user.amount).to eq 10
+      end
     end
 
     it "instantiates PromisePay::Request with the correct path" do
       valid_path = "items/"
       expect(PromisePay::Request).to receive(:new).with(path: valid_path)
+
       described_class.find_all
     end
   end

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

@@ -0,0 +1,13 @@
+{
+  "id": "77e4fc66-b695-4e72-90ac-b454c395b867",
+  "description": "Our callback endpoint",
+  "url": "https://foo.bar/baz",
+  "object_type": "items",
+  "enabled": true,
+  "created_at": "2016-02-10T19:11:18.264Z",
+  "updated_at": "2016-02-10T19:11:18.264Z",
+  "links": {
+    "self": "/callbacks",
+    "responses": "/callbacks/77e4fc66-b695-4e72-90ac-b454c395b867/responses"
+  }
+}

data/spec/support/fixtures/callback/delete.json

@@ -0,0 +1,3 @@
+{
+  "callbacks": "Successfully redacted"
+}

data/spec/support/fixtures/callback/index.json

@@ -0,0 +1,21 @@
+{
+  "callbacks": [
+    {
+      "id": "77e4fc66-b695-4e72-90ac-b454c395b867",
+      "created_at": "2016-02-10T19:11:18.264Z",
+      "updated_at": "2016-02-10T19:11:18.264Z",
+      "description": "",
+      "url": "https://foo.bar/baz",
+      "object_type": "items",
+      "enabled": true
+    }
+  ],
+  "meta": {
+    "limit": 10,
+    "offset": 0,
+    "total": 1
+  },
+  "links": {
+    "self": "/callbacks"
+  }
+}

metadata

@@ -1,108 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: promise_pay
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
 platform: ruby
 authors:
 - Liam Norton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-description: PromisePay gem for API calls wrapped in Ruby
+        version: '1.8'
+description: PromisePay gem for API calls
 email:
 - liam.norton@flippa.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -110,6 +111,7 @@ files:
 - lib/generators/promise_pay/init_generator.rb
 - lib/generators/templates/promise_pay_initializer.rb
 - lib/promise_pay.rb
+- lib/promise_pay/callback.rb
 - lib/promise_pay/collection.rb
 - lib/promise_pay/country.rb
 - lib/promise_pay/fee.rb
@@ -122,6 +124,7 @@ files:
 - lib/promise_pay/user.rb
 - lib/promise_pay/version.rb
 - promise_pay.gemspec
+- spec/promise_pay/callback_spec.rb
 - spec/promise_pay/country_spec.rb
 - spec/promise_pay/fee_spec.rb
 - spec/promise_pay/item_spec.rb
@@ -131,6 +134,9 @@ files:
 - spec/promise_pay/session_spec.rb
 - spec/promise_pay/user_spec.rb
 - spec/spec_helper.rb
+- spec/support/fixtures/callback/create.json
+- spec/support/fixtures/callback/delete.json
+- spec/support/fixtures/callback/index.json
 - spec/support/fixtures/fee/create.json
 - spec/support/fixtures/item/find.json
 - spec/support/fixtures/item/find_all.json
@@ -148,21 +154,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: PromisePay gem
 test_files:
+- spec/promise_pay/callback_spec.rb
 - spec/promise_pay/country_spec.rb
 - spec/promise_pay/fee_spec.rb
 - spec/promise_pay/item_spec.rb
@@ -172,6 +179,9 @@ test_files:
 - spec/promise_pay/session_spec.rb
 - spec/promise_pay/user_spec.rb
 - spec/spec_helper.rb
+- spec/support/fixtures/callback/create.json
+- spec/support/fixtures/callback/delete.json
+- spec/support/fixtures/callback/index.json
 - spec/support/fixtures/fee/create.json
 - spec/support/fixtures/item/find.json
 - spec/support/fixtures/item/find_all.json