ruby_payler 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0d368b0a8f3e7f3c87219161e8f3ba4914d39e6
-  data.tar.gz: 0650a6beebe51d6576d3ee8c1bf38e888e678c56
+  metadata.gz: fd74e6abd4a02a3fa184ac90ee1ab9a1c690ed1f
+  data.tar.gz: 6804de07e127c5a70b15dad88465e8660c81aa6a
 SHA512:
-  metadata.gz: d9714cd332d3319328f8cea4179009a00da87b2be9ac5c71540a0c04887508940c9e8012713213d5ca4e03071a55454a27f29b6877b0bc3769fcddaca204f542
-  data.tar.gz: 9d3d09246589e3cdacaae7646a654027bc950c123e15c5132dc4df0dbc1d161445cc2fe063b10c25432393fa1926d00e38c1c99dd33aec34d214df655f2d6546
+  metadata.gz: ba25bcae20d0f735c7f90d0be20200874d3cfcd0b73620e9d82081b01db42d38eee6de390415d40af3dfa22d08f7fac8a0e0e8bdeb3d57fa35e70837fd6ee622
+  data.tar.gz: 0ae104a89f812dbbeddb24758822c5a09b8c14ada7b13dc10a255aeaa33c4ef0193ec69d81b4e56318a31fcd3bf4f90074f73bc73723c78f804825174eb980b6

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /test/config.yml
+/fixtures/vcr_cassettes/

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - 'bin/*'
+    - 'config/**/*'
+    - 'db/**/*'
+    - 'Guardfile'
+    - 'Gemfile'
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/LineLength:
+  Max: 100
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/MultilineMethodCallBraceLayout:
+  EnforcedStyle: new_line
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# RubyPayler Changelog
+
+## v0.2.0
+* Major update: implement 100% of methods
+* Achieve 100% test coverage
+* Change config file format
+* Change commands to run tests
+* Add command to build coverage report
+* Add some development dependencies
+* Update Readme
+* Add Changelog
+
+## v0.1.9
+* Implement all necessary methods for Busfor usage
+

data/README.md

@@ -1,12 +1,20 @@
 # RubyPayler
-Ruby wrapper for payler.com API
+Ruby wrapper for payler.com Gate API v1.11
 
-_Not all methods, parameters are implemented. There's an issue about that and I'm going to resolve it a bit later._
+_This is not Merchant API_
 
-Documentation for API is here: http://payler.com/docs/acquiring.html
+
+Documentation for API is here: [pdf](http://payler.com/download/docs/%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5%20Payler%20Gate%20API.pdf) and here: http://payler.com/docs/acquiring.html
 
 Documentation for this gem: http://www.rubydoc.info/gems/ruby_payler/
 
+## Highlights
+- 100% of API methods implemented
+- 100% test coverage
+- tests perform real interactions with Payler API via Capybara and PhantomJs
+- tests work fast and offline with VCR cassettes
+- battle-tested at [busfor.ru](https://busfor.ru), more than 200000 payments processed
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -76,11 +84,17 @@ See tests for more usage examples
 
 ## Errors
 In case of any error RubyPayler `raises` RubyPayler::Error.
-There are two child types of Errors:
-- FailedRequest - for failed network request (FaradayError)
-- ResponseWithError - for response with status != 200 and error in body
+There are three child types of Errors:
+- ResponseError - for responses with error in body
+- NetworkError - for failed network request
+- UnexpectedResponseError - for responses with status != 200 but without error in body
+
+All RubyPayler errors have methods _code_, _message_ and _to_s_
 
-ResponseWithError objects has methods to access _error_, _code_, _message_ of error returned in resonse.
+Examples of errors `to_s`:
+- ResponseError: `Payler responded with error: Invalid amount of the transaction., code 1`
+- NetworkError: `NetworkError occured while performing request to Payler: #<Faraday::Error: Faraday::Error>`
+- UnexpectedResponseError: `Unexpected response: code - 503, body - `
 
 ## Tests
 *Tests make real calls to Payler.com web API.*
@@ -89,7 +103,19 @@ Cool, because it really test workflows of interaction with payler equiring via r
 
 Payment step in tests is automated with Capybara and PhantomJS (cool as well).
 
-You can switch to make Payment step by hand via config file (use_capybara: false).
+You can also switch to make Payment step by hand via ENV variable.
+
+```bash
+REFRESH_CAPYBARA=1 rake test # Regenerate VCR-cassettes using capybara to pay
+REFRESH_BY_HAND=1 rake test # Regenerate VCR-cassettes paying by hand
+```
+
+After VCR-cassettes are saved launch `rake test` for fast test run
+
+## Coverage
+**Current test coverage is 100%**
+
+To rebuild coverage report use `COVERAGE=1 rake test` command
 
 ## Config
 Make file config.yml by copying config_example.yml
@@ -98,7 +124,10 @@ Fill in your Payler key, password, host
 
 Fill test card number, vaild_till, code, name for automated payment by capybara
 
-Change use_capybara to false to make payment by hand
+## Note on Pay method
+This gem has methods `pay_page_url` instead of `pay` method, mentioned in Payler docs.
+
+This is due to a fact that `pay` method does in fact return payment page url, and does not do any paying.
 
 ## Development
 To run automated tests with capybara install PhantomJS (_brew install phantomjs on MacOS_)
@@ -110,10 +139,12 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
-
 Bug reports and pull requests are welcome on GitHub at https://github.com/busfor/ruby_payler. 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.
 
 
+## Changelog
+[Changelog](CHANGELOG.md)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/lib/ruby_payler.rb

@@ -1,4 +1,4 @@
-require "ruby_payler/version"
-require "ruby_payler/payler"
-require "ruby_payler/errors"
-require "ruby_payler/constants"
+require 'ruby_payler/version'
+require 'ruby_payler/payler'
+require 'ruby_payler/errors'
+require 'ruby_payler/constants'

data/lib/ruby_payler/connection.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module RubyPayler
+  # Network connection to Payler
+  class Connection
+    def initialize(url:, key:, debug: false)
+      @driver = Faraday.new(url: url, params: { key: key }) do |f|
+        f.request :url_encoded # form-encode POST params
+
+        f.response :mashify          # 3. mashify parsed JSON
+        f.response :json             # 2. parse JSON
+        f.response :logger if debug  # 1. log requests to STDOUT
+
+        f.adapter Faraday.default_adapter # make requests with Net::HTTP
+      end
+    end
+
+    def post(endpoint, params)
+      @driver.post(endpoint, params)
+    end
+  end
+end

data/lib/ruby_payler/errors.rb

@@ -1,43 +1,79 @@
 module RubyPayler
+  # Base error class for all RubyPayler errors
+  # Every RubyPayler Error Class must have code, message and to_s methods!
   class Error < RuntimeError
+  end
+
+  # Response.body contains error
+  class ResponseError < Error
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    # Payler error code
     def code
-      raise NotImplementedError
+      response_error.code
     end
 
+    # Payler error description
     def message
-      raise NotImplementedError
+      response_error.message
+    end
+
+    def to_s
+      "Payler responded with error: #{message}, code #{code}"
+    end
+
+    private
+
+    def response_error
+      @response_error ||= response.body.error
     end
   end
 
-  # Faraday errors
-  class FailedRequest < Error
+  # Unexpected response
+  class UnexpectedResponseError < Error
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
     def code
-      'FailedRequest'
+      @code ||= response.status
+    end
+
+    def body
+      @body ||= response.body
     end
 
     def message
-      self.to_s
+      "Unexpected response: code - #{code}, body - #{body}"
     end
-  end
 
-  # Response.body contains error
-  class ResponseWithError < Error
-    attr_reader :error
+    def to_s
+      message
+    end
+  end
 
-    def initialize(error)
-      @error = error
+  # Network Error (Faraday exception)
+  class NetworkError < Error
+    def initialize(faraday_error)
+      @faraday_error = faraday_error
     end
 
     def code
-      error.code
+      'NetworkError'
     end
 
     def message
-      error.message
+      @faraday_error.inspect
     end
 
     def to_s
-      "#{self.class}-#{code}-#{message}"
+      "NetworkError occured while performing request to Payler: #{message}"
     end
   end
 end

data/lib/ruby_payler/payler.rb

@@ -1,122 +1,123 @@
-require 'faraday'
-require 'faraday_middleware'
+require 'ruby_payler/connection'
 
 module RubyPayler
+  # Wrapper for payler gate api
   class Payler
-    attr_reader :host, :key, :password
+    attr_reader :host, :key, :password, :debug, :payler_url
 
     def initialize(host:, key:, password:, debug: false)
       @host = host
       @key = key
       @password = password
+      @debug = debug
 
-      @connection = Faraday.new(
-        url: "https://#{host}.payler.com",
-        params: { key: @key },
-      ) do |f|
-        f.request  :url_encoded # form-encode POST params
-
-        f.params
-
-        f.response :mashify          # 3. mashify parsed JSON
-        f.response :json             # 2. parse JSON
-        f.response :logger if debug  # 1. log requests to STDOUT
-
-        f.adapter  Faraday.default_adapter  # make requests with Net::HTTP
-      end
+      @payler_url = "https://#{host}.payler.com/gapi/"
     end
 
     def start_session(
-      order_id:,
       type:,
+      order_id:,
       cents:,
-      currency:,
-      lang:,
-      product: nil,
-      userdata: nil
+      **other_session_params
     )
-      params =
-      call_payler_api('gapi/StartSession', {
-        key: key,
+      call_payler_api('StartSession',
         type: type,
         order_id: order_id,
-        currency: currency,
         amount: cents,
-        lang: lang,
-        product: product,
-        userdata: userdata,
-      })
+        **other_session_params,
+      )
+    end
+
+    def find_session(order_id)
+      call_payler_api('FindSession', order_id: order_id)
     end
 
     def pay_page_url(session_id)
-      "#{connection.url_prefix.to_s}gapi/Pay?key=#{key}&session_id=#{session_id}"
+      "#{payler_url}Pay?key=#{key}&session_id=#{session_id}"
     end
 
     def get_status(order_id)
-      call_payler_api('gapi/GetStatus', {
-        key: key,
-        order_id: order_id,
-      })
+      call_payler_api('GetStatus', order_id: order_id)
     end
 
     def get_advanced_status(order_id)
-      call_payler_api('gapi/GetAdvancedStatus', {
-        key: key,
-        order_id: order_id,
-      })
+      call_payler_api('GetAdvancedStatus', order_id: order_id)
     end
 
     def charge(order_id, amount)
-      call_payler_api('gapi/Charge', {
-        key: key,
+      call_payler_api('Charge',
         password: password,
         order_id: order_id,
         amount: amount,
-      })
+      )
     end
 
     def retrieve(order_id, amount)
-      call_payler_api('gapi/Retrieve', {
-        key: key,
+      call_payler_api('Retrieve',
         password: password,
         order_id: order_id,
         amount: amount,
-      })
+      )
     end
 
     def refund(order_id, amount)
-      call_payler_api('gapi/Refund', {
-        key: key,
+      call_payler_api('Refund',
         password: password,
         order_id: order_id,
         amount: amount,
-      })
+      )
     end
 
-    private
+    def get_template(recurrent_template_id)
+      call_payler_api('GetTemplate',
+        recurrent_template_id: recurrent_template_id,
+      )
+    end
 
-    def connection
-      @connection
+    def activate_template(recurrent_template_id, active)
+      call_payler_api('ActivateTemplate',
+        recurrent_template_id: recurrent_template_id,
+        active: active,
+      )
     end
 
-    def remove_nils_from_params!(params)
-      params.delete_if { |k, v| v.nil? }
+    def repeat_pay(order_id:, amount:, recurrent_template_id:)
+      call_payler_api('RepeatPay',
+        order_id: order_id,
+        amount: amount,
+        recurrent_template_id: recurrent_template_id,
+      )
+    end
+
+    private
+
+    def connection
+      @connection ||= Connection.new(url: payler_url, key: key, debug: debug)
     end
 
     def call_payler_api(endpoint, params)
       remove_nils_from_params!(params)
+      params[:key] = key
 
       begin
         response = connection.post(endpoint, params)
-      rescue Faraday::Error => e
-        raise FailedRequest, e.message
+      rescue Faraday::Error => faraday_error
+        raise RubyPayler::NetworkError, faraday_error
       end
 
-      result = response.body
-      if result.error
-        raise ResponseWithError, result.error
+      response_body = response.body
+      if (response_body.class != Hashie::Mash) ||
+         (response.status != 200 && !response_body.include?(:error))
+        raise RubyPayler::UnexpectedResponseError, response
       end
-      result
+
+      raise RubyPayler::ResponseError, response if response_body.error
+
+      response_body
+    end
+
+    def remove_nils_from_params!(params)
+      params.delete_if { |_key, value| value.nil? }
     end
   end # class Payler
 end # module RubyPayler

data/lib/ruby_payler/version.rb

@@ -1,3 +1,3 @@
 module RubyPayler
-  VERSION = "0.1.9"
+  VERSION = '0.2.0'.freeze
 end

data/ruby_payler.gemspec

@@ -3,34 +3,45 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ruby_payler/version'
 
+def add_production_dependencies(spec)
+  spec.add_dependency 'faraday', '~> 0.9.2'
+  spec.add_dependency 'faraday_middleware', '~> 0.10.0'
+  spec.add_dependency 'hashie', '~> 3.4', '>= 3.4.4'
+end
+
+def add_development_dependencies(spec)
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-minitest', '~> 2.4', '>= 2.4.5'
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6.1'
+  spec.add_development_dependency 'capybara', '~> 2.6', '>= 2.6.2'
+  spec.add_development_dependency 'poltergeist', '~> 1.10'
+  spec.add_development_dependency 'mocha', '>= 1.2.1'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'simplecov'
+end
+
 Gem::Specification.new do |spec|
-  spec.name          = "ruby_payler"
+  spec.name          = 'ruby_payler'
   spec.version       = RubyPayler::VERSION
-  spec.authors       = ["Alexey Vasilyev"]
-  spec.email         = ["bestspajic@gmail.com"]
+  spec.authors       = ['Alexey Vasilyev']
+  spec.email         = ['bestspajic@gmail.com']
 
-  spec.summary       = %q{Ruby wrapper for Payler Gate API.}
-  spec.description   = %q{Ruby wrapper for Payler.com Gate API.}
-  spec.homepage      = "https://github.com/busfor/ruby_payler"
-  spec.license       = "MIT"
+  spec.summary       = 'Ruby wrapper for Payler Gate API.'
+  spec.description   = 'Ruby wrapper for Payler.com Gate API.'
+  spec.homepage      = 'https://github.com/busfor/ruby_payler'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "faraday", "~> 0.9.2"
-  spec.add_dependency "faraday_middleware", "~> 0.10.0"
-  spec.add_dependency "hashie", "~> 3.4", ">= 3.4.4"
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "pry-byebug", "~> 3.4"
-  spec.add_development_dependency "guard", "~> 2.14"
-  spec.add_development_dependency "guard-minitest", "~> 2.4", ">= 2.4.5"
-  spec.add_development_dependency "terminal-notifier-guard", "~> 1.6.1"
-  spec.add_development_dependency "capybara", "~> 2.6", ">= 2.6.2"
-  spec.add_development_dependency "poltergeist", "~> 1.10"
-  spec.add_development_dependency "mocha", ">= 1.2.1"
+  add_production_dependencies(spec)
+  add_development_dependencies(spec)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_payler
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexey Vasilyev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2017-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -210,6 +210,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: simplecov
+  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: Ruby wrapper for Payler.com Gate API.
 email:
 - bestspajic@gmail.com
@@ -218,7 +246,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -228,6 +258,7 @@ files:
 - bin/console
 - bin/setup
 - lib/ruby_payler.rb
+- lib/ruby_payler/connection.rb
 - lib/ruby_payler/constants.rb
 - lib/ruby_payler/errors.rb
 - lib/ruby_payler/payler.rb
@@ -253,7 +284,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Payler Gate API.