paypro 0.0.1

data/lib/paypro.rb

@@ -0,0 +1,14 @@
+require 'openssl'
+require 'json'
+
+require 'faraday'
+
+require 'paypro/client'
+require 'paypro/errors'
+require 'paypro/version'
+
+module PayPro
+  CA_BUNDLE_FILE = File.dirname(__FILE__) + '/data/ca-bundle.crt'
+  API_URL = 'https://paypro.nl/post_api'.freeze
+  API_VERSION = 'v1'.freeze
+end

data/lib/paypro/client.rb

@@ -0,0 +1,66 @@
+module PayPro
+  # Client class to connect to the PayPro V1 API.
+  # Requires an API key to authenticate API calls, you
+  # can also supply your own Faraday connection instead of the default one.
+  # This can be useful if you want to add more middleware or want finer
+  # control of the connection being used.
+  class Client
+    attr_accessor :command, :params
+
+    def initialize(api_key, conn = default_conn)
+      @api_key = api_key
+      @params = {}
+      @conn = conn
+    end
+
+    # Executes the API call and handles the response. Will raise errors if
+    # there were problems while connecting or handeling the response.
+    def execute
+      response = @conn.post do |req|
+        req.body = body
+      end
+      handle_response(response)
+    rescue Faraday::ClientError => e
+      raise ConnectionError, "Could not connect to the PayPro API: #{e.inspect}"
+    end
+
+    # Returns the body that is used in the POST request.
+    def body
+      {
+        apikey: @api_key,
+        command: @command,
+        params: JSON.generate(@params)
+      }
+    end
+
+    private
+
+    def ca_bundle_file
+      PayPro::CA_BUNDLE_FILE
+    end
+
+    def cert_store
+      cert_store = OpenSSL::X509::Store.new
+      cert_store.add_file ca_bundle_file
+      cert_store
+    end
+
+    def default_conn
+      Faraday.new(
+        PayPro::API_URL,
+        ssl: {
+          cert_store: cert_store,
+          verify: true
+        }
+      )
+    end
+
+    def handle_response(response)
+      parsed_response = JSON.parse(response.body)
+      @params = {}
+      parsed_response
+    rescue JSON::ParserError
+      raise InvalidResponseError, "The API request returned an error or is invalid: #{response.body}"
+    end
+  end
+end

data/lib/paypro/errors.rb

@@ -0,0 +1,4 @@
+module PayPro
+  class ConnectionError < StandardError; end
+  class InvalidResponseError < StandardError; end
+end

data/lib/paypro/version.rb

@@ -0,0 +1,3 @@
+module PayPro
+  VERSION = '0.0.1'.freeze
+end

data/paypro.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path('../lib/paypro/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'paypro'
+  s.version = PayPro::VERSION
+  s.license = 'MIT'
+  s.homepage = 'https://github.com/paypronl/paypro-ruby-v1'
+  s.author = 'PayPro'
+  s.email = 'support@paypro.nl'
+  s.summary = 'Ruby client for PayPro API v1'
+
+  s.required_ruby_version = '>= 2.0.0'
+  s.add_dependency 'faraday', '~> 0.13'
+
+  s.add_development_dependency 'rspec', '~> 3.6'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = Dir.glob('spec/**/*_spec.rb')
+
+  s.require_path = 'lib'
+end

data/spec/paypro/client_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe PayPro::Client do
+  let(:api_key) { 'a16e84b3ef5a80ef9af289d37788e87e' }
+  let(:client) { described_class.new(api_key) }
+
+  describe '#initialize' do
+    let(:client) { described_class.new(api_key) }
+
+    it 'sets params to an empty hash' do
+      expect(client.params).to eql({})
+    end
+  end
+
+  describe '#body' do
+    let(:command) { 'create_payment' }
+
+    subject { client.body }
+
+    before { client.command = command }
+
+    it { is_expected.to include(apikey: api_key) }
+    it { is_expected.to include(command: command) }
+
+    context 'when params is empty' do
+      it { is_expected.to include(params: '{}') }
+    end
+
+    context 'when params is not empty' do
+      before { client.params = { amount: 500 } }
+      it { is_expected.to include(params: '{"amount":500}') }
+    end
+  end
+
+  describe '#execute' do
+    let(:client) { described_class.new(api_key, conn) }
+    let(:conn) do
+      Faraday.new do |builder|
+        builder.adapter :test, stubs
+      end
+    end
+
+    subject { client.execute }
+
+    context 'when connection fails' do
+      let(:conn) { double }
+
+      before { allow(conn).to receive(:post).and_raise(Faraday::ClientError, 'Message') }
+
+      it 'raises a PayPro::Connection error' do
+        expect { subject }.to raise_error(PayPro::ConnectionError, kind_of(String))
+      end
+    end
+
+    context 'when body is invalid json' do
+      let(:stubs) do
+        Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.post('/') { |_| [200, {}, 'invalid json }'] }
+        end
+      end
+
+      it 'raises a PayPro::InvalidResponse error' do
+        expect { subject }.to raise_error(
+          PayPro::InvalidResponseError,
+          'The API request returned an error or is invalid: invalid json }'
+        )
+      end
+    end
+
+    context 'when api returns an error' do
+      let(:stubs) do
+        Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.post('/') { |_| [200, {}, 'Invalid amount'] }
+        end
+      end
+
+      it 'raises a PayPro::InvalidResponse error' do
+        expect { subject }.to raise_error(
+          PayPro::InvalidResponseError,
+          'The API request returned an error or is invalid: Invalid amount'
+        )
+      end
+    end
+
+    context 'when api call is valid' do
+      let(:stubs) do
+        Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.post('/') do |_|
+            [
+              200,
+              {},
+              '{"payment_url":"https://paypro.nl/betalen/payment_hash","payment_hash":"payment_hash"}'
+            ]
+          end
+        end
+      end
+
+      before { client.params = { amount: 500 } }
+
+      it 'returns a hash with the response' do
+        expect(subject).to include(
+          'payment_url' => 'https://paypro.nl/betalen/payment_hash',
+          'payment_hash' => 'payment_hash'
+        )
+      end
+
+      it 'clears the old params' do
+        expect { subject }.to change { client.params }.from(amount: 500).to({})
+      end
+    end
+  end
+end

data/spec/paypro_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe PayPro do
+  it 'returns the correct api url' do
+    expect(described_class::API_URL).to eql 'https://paypro.nl/post_api'
+  end
+
+  it 'returns the correct path for ca-bundle.crt' do
+    expect(File).to exist(described_class::CA_BUNDLE_FILE)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+require 'paypro'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: paypro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- PayPro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: 
+email: support@paypro.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- examples/create_payment.rb
+- lib/data/ca-bundle.crt
+- lib/paypro.rb
+- lib/paypro/client.rb
+- lib/paypro/errors.rb
+- lib/paypro/version.rb
+- paypro.gemspec
+- spec/paypro/client_spec.rb
+- spec/paypro_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/paypronl/paypro-ruby-v1
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for PayPro API v1
+test_files:
+- spec/paypro/client_spec.rb
+- spec/paypro_spec.rb