skrill_payments 0.0.2 → 0.0.3

data/README.md

@@ -1,13 +1,4 @@
-# [WIP] -> WORK IN PROGRESS
-
-Plase wait day or two to next release.
-Next update will be 26.5.2014
-
-Thank you very much.
-
-# SkrillPayments
-
-TODO: Write a gem description
+# [WIP] SkrillPayments
 
 ## Installation
 
@@ -23,15 +14,77 @@ Or install it yourself as:
 
     $ gem install skrill_payments
 
-Create config initializer for Skrill Payments.
+Create a configuration file for Scrill Payments.
 
-For example, create a file config/initializers/skrill_payments.rb with following content:
+    $ touch config/initializers/scrill_payments.rb
 
-  Rails.configuration.scrill_payments_email     = 'michal.macejko1@gmail.com'
-  Rails.configuration.scrill_payments_password  = '3427342378427834782347832' # MD5
+    ```ruby
+      Rails.configuration.scrill_payments_email     = 'michal.macejko1@gmail.com'
+      Rails.configuration.scrill_payments_password  = '3427342378427834782347832' # MD5
+    ```
 
 ## Usage
 
+  Put this code into your Payment class.
+
+    ```ruby
+      include ScrillPayment
+    ```
+
+  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
+    ```
+
+  For example:
+
+  ```ruby
+    class Payment
+
+      include ScrillPayment
+
+      def amount
+        price + fees
+      end
+
+      def currency
+        bank.czech? 'CZK' : 'ENG'
+      end
+
+      def recipient_email
+        client.user
+      end
+
+      def subject
+        'My super subject'
+      end
+
+      def note
+        'Money for your service'
+      end
+
+      def reference_id
+        id
+      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
+        # do stuff
+      end
+      redirect_to payments_path
+    end
+  ```
 
 ## Contributing
 

data/lib/skrill_payments.rb

@@ -8,6 +8,18 @@ module SkrillPayments
     execute_transfer['transaction'][0]['status_msg'][0] == 'processed'
   end
 
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
 end
 
 # VERSION
@@ -15,8 +27,10 @@ require 'skrill_payments/version'
 
 # GEM CLASS
 require 'skrill_payments/api'
+require 'skrill_payments/scrill_payment'
 require 'skrill_payments/prepare_transfer'
 require 'skrill_payments/execute_transfer'
+require 'skrill_payments/configuration'
 
 # GEMS
 require 'faraday'

data/lib/skrill_payments/api.rb

@@ -29,8 +29,8 @@ class Api
 
   def default_params
     {
-      email:    Rails.configuration.scrill_payments_email,
-      password: Rails.configuration.scrill_payments_password
+      email:    SkrillPayments.configuration.email,
+      password: SkrillPayments.configuration.password
     }
   end
 

data/lib/skrill_payments/configuration.rb

@@ -0,0 +1,6 @@
+class Configuration
+
+  attr_accessor :email, :password
+
+end
+

data/lib/skrill_payments/version.rb

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

data/skrill_payments.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 
   spec.add_dependency('faraday')
   spec.add_dependency('xml-simple')

data/spec/models/prepare_transfer_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe PrepareTransfer do
+
+  before do
+    @payment          = Payment.new
+    @prepare_transfer = PrepareTransfer.new(@payment)
+  end
+
+  it 'returns all required params' do
+
+    @prepare_transfer.params
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'skrill_payments'
+
+RSpec.configure do |config|
+end
+
+# SUPPORT FILES
+require File.expand_path('../support/config.rb', __FILE__)
+require File.expand_path('../support/payment.rb', __FILE__)
+
+

data/spec/support/config.rb

@@ -0,0 +1,4 @@
+SkrillPayments.configure do |config|
+  config.email     = 'michal.macejko1@gmail.com'
+  config.password  = '2347237842346234623476276'
+end

data/{lib/skrill_payments/payment.rb~ → spec/support/payment.rb}

@@ -1,5 +1,3 @@
-require 'skrill_payments/scrill_payment'
-
 class Payment
   include ScrillPayment
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skrill_payments
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -43,6 +43,22 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
@@ -89,12 +105,16 @@ files:
 - Rakefile
 - lib/skrill_payments.rb
 - lib/skrill_payments/api.rb
+- lib/skrill_payments/configuration.rb
 - lib/skrill_payments/execute_transfer.rb
-- lib/skrill_payments/payment.rb~
 - lib/skrill_payments/prepare_transfer.rb
 - lib/skrill_payments/scrill_payment.rb
 - lib/skrill_payments/version.rb
 - skrill_payments.gemspec
+- spec/models/prepare_transfer_spec.rb
+- spec/spec_helper.rb
+- spec/support/config.rb
+- spec/support/payment.rb
 homepage: ''
 licenses:
 - MIT
@@ -120,4 +140,8 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Skrill payments
-test_files: []
+test_files:
+- spec/models/prepare_transfer_spec.rb
+- spec/spec_helper.rb
+- spec/support/config.rb
+- spec/support/payment.rb