skrill_payments 0.0.3 → 0.0.4

data/README.md

@@ -1,4 +1,4 @@
-# [WIP] SkrillPayments
+# SkrillPayments
 
 ## Installation
 
@@ -14,47 +14,47 @@ Or install it yourself as:
 
     $ gem install skrill_payments
 
-Create a configuration file for Scrill Payments.
+Create a configuration file for Skrill Payments.
 
-    $ touch config/initializers/scrill_payments.rb
+    $ touch config/initializers/skrill_payments.rb
 
-    ```ruby
-      Rails.configuration.scrill_payments_email     = 'michal.macejko1@gmail.com'
-      Rails.configuration.scrill_payments_password  = '3427342378427834782347832' # MD5
-    ```
+With following content.
+
+    SkrillPayments.configure do |config|
+      config.email     = 'michal.macejko1@gmail.com'
+      config.password  = '2347237842346234623476276'
+      # your password in MD5
+    end
 
 ## Usage
 
+  ### SEND MONEY USING AN HTTPS REQUEST
+
   Put this code into your Payment class.
 
-    ```ruby
-      include ScrillPayment
-    ```
+    include SkrillPayment
 
   Your payment class must contain all attributes/methods which is required for transfer money.
 
-    ```ruby
-      [:amount, :currency, :recipient_email, :subject, :note, :reference_id]
-      # :reference_id is optional attribute
-    ```
+    [:amount, :currency, :recipient_email, :subject, :note, :reference_id]
+    # :reference_id is optional attribute
 
   For example:
 
-  ```ruby
     class Payment
 
-      include ScrillPayment
+      include SkrillPayment
 
       def amount
         price + fees
       end
 
       def currency
-        bank.czech? 'CZK' : 'ENG'
+        bank.czech? ? 'CZK' : 'ENG'
       end
 
       def recipient_email
-        client.user
+        client.email
       end
 
       def subject
@@ -70,21 +70,18 @@ Create a configuration file for Scrill Payments.
       end
 
     end
-  ```
 
   And in your controller just put the following code:
 
-  ```ruby
     def pay_for_service
       payment = Payment.find(params[:id])
       begin
-        ScrillPayment.pay!(payment)
-      rescue => e
+        SkrillPayments.pay!(payment)
+      rescue SkrillPaymentsException => e
         # do stuff
       end
       redirect_to payments_path
     end
-  ```
 
 ## Contributing
 

data/lib/skrill_payments/api.rb

@@ -1,18 +1,16 @@
-class Api
+module Api
 
   BASE_URL = 'https://www.moneybookers.com/app/pay.pl'
 
-  attr_reader :conection, :payment
-
-  def initialize
-    @conection = Faraday.new(url: BASE_URL)
-  end
+  attr_reader :payment
 
   def call
-    response  = conection.get '', params
+    response  = connection.get '', params.merge(default_params)
     data      = XmlSimple.xml_in(response.body)
 
-    raise data['error'].inspect if data['error']
+    if data['error']
+      raise SkrillPaymentsException, data['error']
+    end
 
     data
   end
@@ -24,7 +22,7 @@ class Api
     attributes.each do |attribute|
       request_params[attribute] = object.send(attribute)
     end
-    request_params.merge(default_params)
+    request_params
   end
 
   def default_params
@@ -34,4 +32,10 @@ class Api
     }
   end
 
+  private
+
+  def connection
+    Faraday.new(url: BASE_URL)
+  end
+
 end

data/lib/skrill_payments/execute_transfer.rb

@@ -1,10 +1,11 @@
-class ExecuteTransfer < Api
+class ExecuteTransfer
+
+  include Api
 
   ATTRIBUTES = [:sid]
 
   def initialize(payment)
     @payment = payment
-    super()
   end
 
   def params

data/lib/skrill_payments/prepare_transfer.rb

@@ -1,10 +1,11 @@
-class PrepareTransfer < Api
+class PrepareTransfer
+
+  include Api
 
   ATTRIBUTES = [:amount, :currency, :bnf_email, :subject, :note, :frn_trn_id]
 
   def initialize(payment)
     @payment = payment
-    super()
   end
 
   def params

data/lib/skrill_payments/{scrill_payment.rb → skrill_payment.rb}

@@ -1,4 +1,4 @@
-module ScrillPayment
+module SkrillPayment
 
   attr_accessor :sid
 

data/lib/skrill_payments/skrill_payments_exception.rb

@@ -0,0 +1,2 @@
+class SkrillPaymentsException < StandardError
+end

data/lib/skrill_payments/version.rb

@@ -1,3 +1,3 @@
 module SkrillPayments
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/skrill_payments.rb

@@ -1,11 +1,11 @@
 module SkrillPayments
 
   def self.pay!(payment)
-    prepare_transfer  = PrepareTransfer.new(payment).call
-    payment.sid       = prepare_transfer['sid'][0]
-    execute_transfer  = ExecuteTransfer.new(payment).call
+    prepare_transfer = PrepareTransfer.new(payment).call
 
-    execute_transfer['transaction'][0]['status_msg'][0] == 'processed'
+    payment.sid = prepare_transfer['sid'][0]
+
+    !!ExecuteTransfer.new(payment).call
   end
 
   class << self
@@ -27,9 +27,10 @@ require 'skrill_payments/version'
 
 # GEM CLASS
 require 'skrill_payments/api'
-require 'skrill_payments/scrill_payment'
+require 'skrill_payments/skrill_payment'
 require 'skrill_payments/prepare_transfer'
 require 'skrill_payments/execute_transfer'
+require 'skrill_payments/skrill_payments_exception'
 require 'skrill_payments/configuration'
 
 # GEMS

data/skrill_payments.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
 
   spec.add_dependency('faraday')
   spec.add_dependency('xml-simple')

data/spec/models/api_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+class Dummie
+  include Api
+end
+
+describe Api do
+
+  it 'creates params -> values from object, keys from attributes' do
+
+    object      = double('Payment', currency: 'CZK', amount: 10, user_id: 20)
+    attributes  = [:currency, :amount]
+    params      = Dummie.new.send(:params, object, attributes)
+
+    expect(params).to eq({ currency: 'CZK', amount: 10 })
+  end
+
+  it 'creates default params from config' do
+
+    params = Dummie.new.send(:default_params)
+
+    expect(params).to eq(
+      {
+        email:    'michal.macejko1@gmail.com',
+        password: '2347237842346234623476276'
+      }
+    )
+  end
+end

data/spec/models/execute_transfer_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe ExecuteTransfer do
+
+  before do
+    @payment          = Payment.new
+    @payment.sid      = '4234278347827823487'
+    @prepare_transfer = ExecuteTransfer.new(@payment)
+  end
+
+  it 'returns all required params' do
+
+    params = @prepare_transfer.params
+
+    ExecuteTransfer::ATTRIBUTES.each do |attribute|
+      expect(params.include?(attribute)).to eq true
+    end
+  end
+
+  it 'merge parent default params' do
+
+    expect(@prepare_transfer.default_params.include?(:email)).to eq true
+  end
+
+  it 'must contain specified attributes' do
+
+    expect(ExecuteTransfer::ATTRIBUTES).to_not eq nil
+  end
+end

data/spec/models/prepare_transfer_spec.rb

@@ -9,8 +9,20 @@ describe PrepareTransfer do
 
   it 'returns all required params' do
 
-    @prepare_transfer.params
+    params = @prepare_transfer.params
 
+    PrepareTransfer::ATTRIBUTES.each do |attribute|
+      expect(params.include?(attribute)).to eq true
+    end
   end
 
+  it 'merge parent default params' do
+
+    expect(@prepare_transfer.default_params.include?(:email)).to eq true
+  end
+
+  it 'must contain specified attributes' do
+
+    expect(PrepareTransfer::ATTRIBUTES).to_not eq nil
+  end
 end

data/spec/models/skrill_payments_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe SkrillPayments do
+
+  before do
+    @payment = Payment.new
+
+    @prepare_success_response = '<?xml version="1.0" encoding="UTF-8"?>' \
+      '<response><sid>5e281d1376d92ba789ca7f0583e045d4</sid> </response>'
+    @prepare_error_response   = '<?xml version="1.0" encoding="UTF-8"?> ' \
+      '<response><error><error_msg>M_AMOUNT</error_msg></error></response>'
+    @execute_success_response = '<?xml version="1.0" encoding="UTF-8"?> ' \
+    '<response> <transaction><amount>1.20</amount> <currency>EUR</currency>' \
+    '<id>497029</id><status>2</status> <status_msg>processed</status_msg> ' \
+    '</transaction></response>'
+    @execute_error_response   = '<?xml version="1.0" encoding="UTF-8"?> ' \
+    '<response><error><error_msg>M_AMOUNT</error_msg></error></response>'
+  end
+
+  describe '.pay!' do
+
+    it 'raise error -> Prepare transfer error' do
+
+      stub_request(:get, /action=prepare/).
+        with(headers: { 'Accept'=>'*/*' }).
+        to_return(status: 200, body: @prepare_error_response, headers: {})
+
+      expect{ SkrillPayments.pay!(@payment) }.to raise_error(SkrillPaymentsException)
+    end
+
+    it 'raise error -> Execute transfer error' do
+
+      stub_request(:get, /action=prepare/).
+        with(headers: { 'Accept'=>'*/*' }).
+        to_return(status: 200, body: @prepare_success_response, headers: {})
+
+      stub_request(:get, /action=transfer/).
+        with(headers: { 'Accept'=>'*/*' }).
+        to_return(status: 200, body: @execute_error_response, headers: {})
+
+      expect{ SkrillPayments.pay!(@payment) }.to raise_error(SkrillPaymentsException)
+    end
+
+    context 'success responses' do
+
+      before do
+
+        stub_request(:get, /action=prepare/).
+          with(headers: { 'Accept'=>'*/*' }).
+          to_return(status: 200, body: @prepare_success_response, headers: {})
+
+        stub_request(:get, /action=transfer/).
+          with(headers: { 'Accept'=>'*/*' }).
+          to_return(status: 200, body: @execute_success_response, headers: {})
+      end
+
+      it 'returns true' do
+        expect(SkrillPayments.pay!(@payment)).to eq true
+      end
+
+      it 'set attribute sid for payment' do
+
+        SkrillPayments.pay!(@payment)
+
+        expect(@payment.sid).to_not eq nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'bundler/setup'
 Bundler.setup
 
 require 'skrill_payments'
+require 'webmock/rspec'
 
 RSpec.configure do |config|
 end
@@ -10,4 +11,5 @@ end
 require File.expand_path('../support/config.rb', __FILE__)
 require File.expand_path('../support/payment.rb', __FILE__)
 
+WebMock.disable_net_connect!(allow_localhost: true)
 

data/spec/support/payment.rb

@@ -1,5 +1,5 @@
 class Payment
-  include ScrillPayment
+  include SkrillPayment
 
   def amount
     10

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skrill_payments
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-25 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,22 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -108,10 +124,14 @@ files:
 - lib/skrill_payments/configuration.rb
 - lib/skrill_payments/execute_transfer.rb
 - lib/skrill_payments/prepare_transfer.rb
-- lib/skrill_payments/scrill_payment.rb
+- lib/skrill_payments/skrill_payment.rb
+- lib/skrill_payments/skrill_payments_exception.rb
 - lib/skrill_payments/version.rb
 - skrill_payments.gemspec
+- spec/models/api_spec.rb
+- spec/models/execute_transfer_spec.rb
 - spec/models/prepare_transfer_spec.rb
+- spec/models/skrill_payments_spec.rb
 - spec/spec_helper.rb
 - spec/support/config.rb
 - spec/support/payment.rb
@@ -141,7 +161,10 @@ signing_key:
 specification_version: 3
 summary: Skrill payments
 test_files:
+- spec/models/api_spec.rb
+- spec/models/execute_transfer_spec.rb
 - spec/models/prepare_transfer_spec.rb
+- spec/models/skrill_payments_spec.rb
 - spec/spec_helper.rb
 - spec/support/config.rb
 - spec/support/payment.rb