paypal_client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01521c538a5f17d341615b44eeb0b6375d378eee
-  data.tar.gz: 4cc16db9b1daa24a4275d87f60755ae7174bf547
+  metadata.gz: 2279ec026d46415c6c4ba27b11f14fba739eafa9
+  data.tar.gz: 556beeb56f57d81e19750c2e87478462e3d9a587
 SHA512:
-  metadata.gz: 6f90fcbd2b1bb7824e08daaee89c6efff9f01849d4a7d08d1699439a76f0f858da9d286b4c20fcc52adaa8503f3bd594c3123ddf218f96bf83c85f3a33628496
-  data.tar.gz: fda01a2b8fd05cf1a1985e406418e631f7b2329e9d86126aef06a4f5f7af1651acc204c7114a59aaf53ed9e9d66026dd5d16aa43e47749a39684f0048406d82c
+  metadata.gz: 1150eab9847c8eec968d55a99b94f048c59895d7c0d4947cbd914b889e8d6906449f6c074c81700813e191727727b4890964f1d2271b4c6ebff165ae4bc5508b
+  data.tar.gz: 397a04b94a5b17bf30428daeb1ebe1f34c37f01c1ae5b8d045db6fd929e915dd41a0d96220d53bcc5e1483f0f5a45a84b8cf6ba768038b5962280da48070ed35

data/.travis.yml

@@ -1,11 +1,21 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
+- 2.3.8
+- 2.4.5
+- 2.5.3
+- 2.6.0
+
 before_install: gem install bundler -v 1.16.1
 matrix:
   fast_finish: true
 script:
-  - bundle exec rspec
+- bundle exec rspec --exclude-pattern "spec/integration/*"
+jobs:
+  include:
+  - stage: integration
+    name: Run integration against paypal
+    rvm: 2.5.3
+    allow_failure: true
+    script:
+    - bundle exec rspec spec/integration/

data/Gemfile

@@ -4,3 +4,9 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in paypal_client.gemspec
 gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'rubocop'
+  gem 'simplecov'
+end

data/README.md

@@ -1,8 +1,8 @@
 # PaypalClient
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/paypal_client`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ruby client for the [PayPal REST API](https://developer.paypal.com/docs/api/overview/). PayPal offers their own [SDK](https://github.com/paypal/PayPal-Ruby-SDK) but that felt a big heavy and was not seeing active development at the end of 2018.
 
-TODO: Delete this and the text above, and describe your gem
+PaypalClient is using Faraday to make the http calls to the Paypal API and uses ActiveSupport::Cache::MemoryStore to store the auth token required to make authenticated requests to Paypal [more info](https://developer.paypal.com/docs/api/overview/#authentication-and-authorization).
 
 ## Installation
 
@@ -22,7 +22,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To [list payments](https://developer.paypal.com/docs/api/payments/v1/#payment_list)
+
+```ruby
+paypal_client = PaypalClient::Client.build
+response = paypal_client.get('/payments/payments').body
+response[:payments].each do |payment|
+  puts "Paypal payment with ID: #{payment[:id]}"
+end
+```
+
+`PaypalClient::Client.build` requires the following environment variables to be set:
+
+```shell
+PAYPAL_CLIENT_ID=<paypal_client_id>
+PAYPAL_CLIENT_SECRET=<paypal_client_secret>
+PAYPAL_SANDBOX=true
+```
+
+You can also configure the client using `PaypalClient::Client.new` as in the following example.
+
+```ruby
+paypal_client = PaypalClient::Client.new(
+  client_id: <paypal_client_id>,
+  client_secret: <paypal_client_secret>,
+  sandbox: true,
+  cache: Rails.cache,
+  version: 'v1'
+)
+```
+
+## Documentation
+
+TODO
+
+## Testing
+
+There is a good amount of unit testing in `spec/paypal_client_spec.rb`. To run those test **no** active Paypal Developer account is required. To run the tests in `spec/integration/integration_spec.rb` valid Paypal sandbox credentials are required.
 
 ## Development
 
@@ -32,8 +68,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/paypal_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dennisvdvliet/paypal_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Code of Conduct
 
-Everyone interacting in the PaypalClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/paypal_client/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the PaypalClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dennisvdvliet/paypal_client/blob/master/CODE_OF_CONDUCT.md).

data/lib/paypal_client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'paypal_client/version'
+require 'paypal_client/errors'
 require 'active_support/cache'
 
 module PaypalClient
@@ -38,12 +39,13 @@ module PaypalClient
 
     def connection
       @conn ||= Faraday.new(url: base_url) do |faraday|
+        faraday.use PaypalClient::Errors::Middleware
+
         faraday.headers = default_headers
         faraday.response @logger if @logger
         faraday.request  :json
-        faraday.response :json, parser_options: { symbolize_names: true }
+        faraday.response :json, content_type: /\bjson$/, parser_options: { symbolize_names: true }
 
-        faraday.use ErrorMiddleware
         faraday.adapter *adapter
       end
     end
@@ -102,19 +104,4 @@ module PaypalClient
       Faraday.default_adapter
     end
   end
-
-  class ResponseError < StandardError; end
-  class NotFound < ResponseError; end
-
-  class ErrorMiddleware < Faraday::Response::Middleware
-    ERROR_MAP = {
-      404 => NotFound
-    }.freeze
-
-    def on_complete(response)
-      key = response[:status].to_i
-      raise ERROR_MAP[key], response if ERROR_MAP.key? key
-      raise ResponseError, response if response.status >= 400
-    end
-  end
 end

data/lib/paypal_client/errors.rb

@@ -0,0 +1,67 @@
+require 'faraday_middleware'
+
+module PaypalClient
+  module Errors
+    class Error < StandardError
+      attr_reader :status_code
+      attr_reader :body
+      attr_reader :error
+      attr_reader :error_message
+
+      def initialize(response)
+        @status_code = response.status
+        @body = response.body
+
+        if @body.class == Hash
+          @error = @body[:name] if @body.has_key?(:name)
+          @error_message = @body[:message] if @body.has_key?(:message)
+        else
+          @error = response.reason_phrase if @error.nil?
+        end
+        super(@error)
+      end
+
+      def inspect
+        extra = ""
+        extra << " status_code: #{status_code.inspect}" unless status_code.nil?
+        extra << " body: #{body.inspect}"               unless body.nil?
+        "#<#{self.class.name}: #{message}#{extra}>"
+      end
+    end
+
+    class InvalidRequest < Error; end
+    class AuthenticationFailure < Error; end
+    class NotAuthorized < Error; end
+    class ResourceNotFound < Error; end
+    class MethodNotSupported < Error; end
+    class MediaTypeNotAcceptable < Error; end
+    class UnsupportedMediaType < Error; end
+    class UnprocessableEntity < Error; end
+    class RateLimitReached < Error; end
+    
+    class InternalServerError < Error; end
+    class ServiceUnavailable < Error; end
+
+    class Middleware < ::Faraday::Response::Middleware
+      ERROR_MAP = {
+        400 => InvalidRequest,
+        401 => AuthenticationFailure,
+        403 => NotAuthorized,
+        404 => ResourceNotFound,
+        405 => MethodNotSupported,
+        406 => MediaTypeNotAcceptable,
+        415 => UnsupportedMediaType,
+        422 => UnprocessableEntity,
+        429 => RateLimitReached,
+        500 => InternalServerError,
+        503 => ServiceUnavailable
+      }.freeze
+
+      def on_complete(response)
+        key = response[:status].to_i
+        raise ERROR_MAP[key], response if ERROR_MAP.key? key
+        raise Error, response if response.status >= 400
+      end
+    end
+  end
+end

data/lib/paypal_client/version.rb

@@ -1,3 +1,3 @@
 module PaypalClient
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/paypal_client.gemspec

@@ -35,5 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
+
+  spec.required_ruby_version = '>= 2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypal_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dennis van der Vliet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-19 00:00:00.000000000 Z
+date: 2018-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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: Faraday based API client for the PayPal REST API. Includes support for
   saving the authentication token and limited release endpoints.
 email:
@@ -121,12 +107,12 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/paypal_client.rb
+- lib/paypal_client/errors.rb
 - lib/paypal_client/version.rb
 - paypal_client.gemspec
 homepage: https://github.com/dennisvdvliet/paypal_client
@@ -141,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,73 +0,0 @@
-PATH
-  remote: .
-  specs:
-    paypal_client (0.1.0)
-      activesupport (~> 5)
-      faraday (~> 0.15)
-      faraday_middleware (~> 0.12)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    ast (2.4.0)
-    concurrent-ruby (1.1.4)
-    diff-lcs (1.3)
-    faraday (0.15.4)
-      multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.12.2)
-      faraday (>= 0.7.4, < 1.0)
-    i18n (1.2.0)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.1)
-    minitest (5.11.3)
-    multipart-post (2.0.0)
-    parallel (1.12.1)
-    parser (2.5.3.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.61.1)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  paypal_client!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop
-
-BUNDLED WITH
-   1.16.1