paymill_ruby 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e883a63ce492c9a8875d002cf089970a8368a9eb
+  data.tar.gz: c7393c11f67b212890afef61f1320c2a4d4312c5
+SHA512:
+  metadata.gz: 53000c3a307360159a9b573d4ebdaa94b20bc0e918e4108e086888614595eabede434c2216577a4d4493017b85ab994473f562ccdee6f4318f3ff69db153a84f
+  data.tar.gz: 412035f597b59608248c5c2787554d7fe4e4ecde3f522467b781f97c2d92ebc4ea2a065e9d8fcef0089ba873ac7fe997f90b7259547ff7d6417001a2e498477e

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+v1.0.0
+------
+
+-	initial release inspired by [dkd's paymill-ruby](https://github.com/dkd/paymill-ruby) wrapper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 BSc Vassil Nikolov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,223 @@
+![PAYMILL icon](https://static.paymill.com/r/335f99eb3914d517bf392beb1adaf7cccef786b6/img/logo-download_Light.png)
+
+paymill-ruby
+============
+
+Ruby wrapper for PAYMILL API forked by [dkd's paymill-ruby](https://github.com/dkd/paymill-ruby)
+
+[![Build Status](https://travis-ci.org/paymill/paymill-ruby.svg)](https://travis-ci.org/paymill/paymill-ruby) [![Code Climate](https://codeclimate.com/github/paymill/paymill-ruby/badges/gpa.svg)](https://codeclimate.com/github/paymill/paymill-ruby)
+
+Getting started
+===============
+
+-	If you are not familiar with PAYMILL, start with the [documentation](https://www.paymill.com/en-gb/documentation-3/).
+-	Install the latest release.
+-	Check the API [reference](https://www.paymill.com/en-gb/documentation-3/reference/api-reference/).
+-	Check the specification examples.
+-	Take a look at the [change log](./CHANGELOG.md) for recent updates and improvements.
+
+Installation
+============
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paymill_ruby', '~> 1.0'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+The paymill gem is tested on Ruby 1.9.3, 2.0.0, 2.1.0, 2.1.3 and 2.1.5. It requires ruby version 1.9.3+
+
+Usage
+=====
+
+Initialize the library by providing your api key:
+
+```ruby
+require 'paymill'
+
+Paymill.api_key = '<YOUR PRIVATE API KEY>'
+```
+
+or by reading it from the envirounment variables
+
+```ruby
+require 'paymill'
+
+Paymill.api_key = ENV['PAYMILL_API_TEST_KEY']
+```
+
+Clients
+-------
+
+#### Creating clients
+
+Creating via factory method **create**, which expects an optional hash as arguments. If some of the required attributes are missing the method will throw **ArgumentError**.
+
+With a hash of optional arguments:
+
+```ruby
+client = Paymill::Client.create( email: 'john.rambo@qaiware.com', description: 'Main caracter in First Blood' )
+```
+
+Without mandatory arguments:
+
+```ruby
+client = Paymill::Client.create
+```
+
+#### Find existing client
+
+You can retrieve an object by using the **find** method with an object id:
+
+```ruby
+client = Paymill::Client.find( 'client_b54ff8b3811e06c02e14' )
+```
+
+or with the instance itself:
+
+```ruby
+client = Paymill::Client.find( client )
+```
+
+#### Update client
+
+Update is done by modifying the instance variables of the object. The object itself provides accessor methods only for properties which can be updated.
+
+```ruby
+client = Paymill::Client.find( 'client_b54ff8b3811e06c02e14' )
+
+client.email = 'john.rambo.2@qaiware.com'
+client.description = 'Main caracter in First Blood II'
+
+client.update
+```
+
+#### Deleting client
+
+You may delete objects by calling the its instance method **delete**. The delete method will return <code>nil</code> when the given object is removed successfully.
+
+```ruby
+client = Paymill::Client.find( 'client_b54ff8b3811e06c02e14' )
+client.delete
+```
+
+#### Retrieving lists
+
+To retrieve a list you may simply use the **all** class method
+
+```ruby
+clients = Paymill::Client.all
+```
+
+You may provide filter, order, offset and count parameters to list method
+
+```ruby
+clients = Paymill::Client.all( order: [:email, :created_at_desc], count: 30, offset: 10, filters: [email: 'john.rambo@qaiware.com', created_at: "#{4.days.ago.to_i}-#{2.days.ago.to_i}"] )
+```
+
+Offer
+-----
+
+#### Update offer
+
+When you want to update the offer and to apply the new changes to its subscriptions you can pass an additional parameter <code>update_subscriptions</code> set to <code>true</code> to its instance method **update**
+
+```ruby
+offer = Offer.find( 'offer_b54ff8b3811e06c02e14' )
+offer.amount = 1000
+
+offer.update( update_subscriptions: true )
+```
+
+#### Deleting offer
+
+To delete an offer and its corresponding subscriptions call
+
+```ruby
+offer = Offer.find( 'offer_b54ff8b3811e06c02e14' )
+offer.delete_with_subscriptions()
+```
+
+To delete an offer but leave its corresponding subscriptions call
+
+```ruby
+offer = Offer.find( 'offer_b54ff8b3811e06c02e14' )
+offer.delete_without_subscriptions
+```
+
+To delete an offer and its corresponding subscriptions you can call the instance method **delete** with an argument <code>remove_with_subscriptions</code> set to <code>true</code>
+
+```ruby
+offer = Offer.find( 'offer_b54ff8b3811e06c02e14' )
+offer.delete( remove_with_subscriptions: true )
+```
+
+Refund
+------
+
+#### Creating refunds
+
+To create a refund you have to pass a transaction, which you want to be refunded.
+
+```ruby
+transaction = Transaction.create( token: '098f6bcd4621d373cade4e832627b4f6', amount: 990, currency: 'EUR' )
+refund = Refund.create( transaction, amount: 100 )
+```
+
+Checksum
+--------
+
+#### Creating plain checksum
+
+```ruby
+Checksum.create( checksum_type: 'paypal', amount: 4200, currency: 'EUR', description: 'Chuck Testa', return_url: 'https://testa.com', cancel_url: 'https://test.com/cancel' )
+```
+
+#### Creating checksum with address
+
+```ruby
+billing_address = Address.new( name: 'Primary', street_address: 'Rambo Str.', street_address_addition: '', city: 'Sofia', state: 'Sofia', postal_code: 1234, country: 'BG', phone: '088 41 555 27' )
+Checksum.create( checksum_type: 'paypal', amount: 4200, currency: 'EUR', description: 'Chuck Testa', return_url: 'https://testa.com', cancel_url: 'https://test.com/cancel', billing_address: billing_address )
+```
+
+#### Creating checksum with items
+
+```ruby
+rambo_poster = ShoppingCartItem.new( name: "Rambo Poster", description: "John J. Rambo", amount: 2200, quantity: 3, item_number: "898-24342-343", url: "http://www.store.com/items/posters/12121-rambo" )
+comando_poster = ShoppingCartItem.new( name: "Comando Poster", description: "John Matrix", amount: 3100, quantity: 1, item_number: "898-24342-341", url: "http://www.store.com/items/posters/12121-comando" )
+Checksum.create( checksum_type: 'paypal', amount: 9700, currency: 'EUR', description: 'Chuck Testa', return_url: 'https://testa.com', cancel_url: 'https://test.com/cancel', items: [rambo_poster, comando_poster] )
+```
+
+#### Creating checksum with fee
+
+```ruby
+Checksum.create( checksum_type: 'paypal', amount: 9700, currency: 'EUR', description: 'Chuck Testa', return_url: 'https://testa.com', cancel_url: 'https://test.com/cancel', fee_amount: 100, fee_payment: 'pay_3af44644dd6d25c820a8', fee_currency: 'EUR', app_id: '8fh98hfd828ej2e09dk0hf9' )
+```
+
+Changelog
+=========
+
+### 1.0.0
+* fix [issue #6](https://github.com/paymill/paymill-ruby/issues/6) Add new parameter mandate_reference
+* fix [issue #7](https://github.com/paymill/paymill-ruby/issues/7) ActiveSupport 4.1 requirement
+* fix [issue #8](https://github.com/paymill/paymill-ruby/issues/8) No access to iban and bic
+* fix [issue #9](https://github.com/paymill/paymill-ruby/issues/9) Add explanation on how to run the spec
+* Add Checksum, Address and ShoppingCartItem objects for paypal payments.
+
+Contributing
+============
+
+1.	Fork it ( https://github.com/paymill/paymill-ruby/fork )
+2.	Create your feature branch (`git checkout -b my-new-feature`)
+3.	Setup the project (`bundle install`)
+4.	Setup PAYMILL's test key in your environment (`export PAYMILL_API_TEST_KEY="<YOUR_TEST_KEY>"`)
+5.	Run all the tests (`rspec .)` or a subset from them (`rspec ./spec/paymill/models/client_spec.rb`)
+6.	Commit your changes (`git commit -am 'Add some feature'`)
+7.	Push to the branch (`git push origin my-new-feature`)
+8.	Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/paymill.rb

@@ -0,0 +1,54 @@
+require 'json'
+require 'net/https'
+require "paymill/version"
+require 'paymill/errors'
+require 'paymill/restful/methods'
+
+module Paymill
+  API_VERSION   = 'v2.1'
+  API_BASE      = 'api.paymill.com'
+
+  autoload :Address,              'paymill/models/address'
+  autoload :Base,                 'paymill/models/base'
+  autoload :Checksum,             'paymill/models/checksum'
+  autoload :Client,               'paymill/models/client'
+  autoload :Fee,                  'paymill/models/fee'
+  autoload :Invoice,              'paymill/models/invoice'
+  autoload :Merchant,             'paymill/models/merchant'
+  autoload :Offer,                'paymill/models/offer'
+  autoload :Payment,              'paymill/models/payment'
+  autoload :PaymentMethod,        'paymill/models/payment_method'
+  autoload :Preauthorization,     'paymill/models/preauthorization'
+  autoload :Refund,               'paymill/models/refund.rb'
+  autoload :ShoppingCartItem,     'paymill/models/shopping_cart_item'
+  autoload :Subscription,         'paymill/models/subscription'
+  autoload :SubscriptionCount,    'paymill/models/subscription_count'
+  autoload :Transaction,          'paymill/models/transaction'
+  autoload :Webhook,              'paymill/models/webhook'
+
+  def self.api_version
+    API_VERSION
+  end
+
+  def self.api_key
+    @@api_key
+  end
+
+  def self.api_key=( api_key )
+    @@api_key = api_key
+  end
+
+  def self.request( payload )
+    raise AuthenticationError unless Paymill.api_key
+    https ||= Net::HTTP.new( API_BASE, Net::HTTP.https_default_port)
+    https.use_ssl = true
+
+    response = https.start do
+      https.request( payload )
+    end
+
+    raise PaymillError, response.body unless response.class.eql? Net::HTTPOK
+    JSON.parse( response.body )
+  end
+
+end

data/lib/paymill/errors.rb

@@ -0,0 +1,10 @@
+module Paymill
+  class PaymillError < StandardError
+  end
+
+  class AuthenticationError < PaymillError
+  end
+
+  class NotFoundError < PaymillError
+  end
+end

data/lib/paymill/models/address.rb

@@ -0,0 +1,13 @@
+module Paymill
+  class Address
+    attr_accessor :name, :street_address, :street_address_addition, :city, :state, :postal_code, :country, :phone
+
+    def initialize( arguments = {} )
+      arguments.each do |key, value|
+        raise ArgumentError.new( "parameter #{key} is not allowed" ) unless Address.instance_methods( false ).include? key
+        instance_variable_set( "@#{key}", ( Integer( value ) rescue value ) )
+      end
+    end
+
+  end
+end

data/lib/paymill/models/base.rb

@@ -0,0 +1,50 @@
+module Paymill
+  class Base
+    extend Restful::All
+    extend Restful::Find
+    extend Restful::Create
+
+    attr_reader :id, :created_at, :updated_at, :app_id
+
+    def initialize( json )
+      deserialize( json )
+      parse_timestamps
+    end
+
+    protected
+    def self.create_with?( incoming_arguments )
+      return false if mandatory_arguments.select { |a| incoming_arguments.include? a }.size < mandatory_arguments.size
+      allowed_arguments.size == ( allowed_arguments | incoming_arguments ).size
+    end
+
+    # Parses UNIX timestamps and creates Time objects.
+    def parse_timestamps
+      @created_at &&= Time.at( @created_at )
+      @updated_at &&= Time.at( @updated_at )
+    end
+
+    private
+    def deserialize( json )
+      json.each_pair do |key, value|
+        case value.class.name
+        when 'Array'
+          unless key[-1].eql? 's'
+            instance_variable_set( "@#{key}s", value.map { |e| (e.is_a? String) ? e : objectize( key, e ) } )
+          else
+            instance_variable_set( "@#{key}", value.map { |e| (e.is_a? String) ? e : objectize( key, e ) } )
+          end
+        when 'Hash'
+          instance_variable_set( "@#{key}", objectize( key, value ) )
+        else
+          instance_variable_set( "@#{key}", (Integer( value ) rescue value) )
+        end
+      end
+    end
+
+    # Converts the given 'hash' object into an instance of class with name stored in 'clazz' variable
+    def objectize( clazz, hash )
+      Module.const_get( "#{self.class.name.split( '::' ).first}::#{clazz.split('_').map(&:capitalize).join}" ).new( hash )
+    end
+
+  end
+end

data/lib/paymill/models/checksum.rb

@@ -0,0 +1,40 @@
+module Paymill
+  class Checksum
+    extend Restful::Create
+
+    attr_reader :id, :created_at, :updated_at, :app_id, :action, :checksum, :data, :type, :shipping_address
+
+    def initialize( json )
+      deserialize( json )
+      parse_timestamps
+    end
+
+    protected
+    def self.create_with?( incoming_arguments )
+      return false if mandatory_arguments.select { |a| incoming_arguments.include? a }.size < mandatory_arguments.size
+      allowed_arguments.size == ( allowed_arguments | incoming_arguments ).size
+    end
+
+    def self.allowed_arguments
+      [:checksum_type, :amount, :currency, :description, :return_url, :cancel_url, :items, :shipping_address, :billing_address, :fee_amount, :fee_payment, :fee_currency, :app_id]
+    end
+
+    def self.mandatory_arguments
+      [:checksum_type, :amount, :currency, :return_url, :cancel_url]
+    end
+
+    # Parses UNIX timestamps and creates Time objects.
+    def parse_timestamps
+      @created_at &&= Time.at( @created_at )
+      @updated_at &&= Time.at( @updated_at )
+    end
+
+    private
+    def deserialize( json )
+      json.each_pair do |key, value|
+        instance_variable_set( "@#{key}", (Integer( value ) rescue value) )
+      end
+    end
+
+  end
+end