openpay 1.0.1 → 1.0.2

data/lib/openpay/errors/openpay_exception_factory.rb

@@ -0,0 +1,60 @@
+class OpenpayExceptionFactory
+
+
+
+  def   OpenpayExceptionFactory::create(exception)
+
+    LOG.warn("An exception has been raised (original exception class: #{exception.class})")
+    LOG.warn("An exception has been raised (original exception class: #{exception.message })")
+
+
+    case exception
+
+      #resource not found
+      #malformed jason, invalid data, invalid request
+      when   RestClient::BadRequest , RestClient::ResourceNotFound ,
+                   RestClient::Conflict , RestClient::PaymentRequired ,
+                   RestClient::UnprocessableEntity
+
+            oe=OpenpayTransactionException.new exception.http_body
+            LOG.warn "-OpenpayTransactionException: #{exception.http_body}"
+            @errors=true
+            raise  oe
+
+
+
+      #connection, timeouts, network related errors
+      when Errno::EADDRINUSE , Errno::ETIMEDOUT ,OpenSSL::SSL::SSLError
+        #since this execeptions are not based on the rest api exeptions
+        #we do not have the json message so we just build the exception
+        #with the original exception message set in e.description and e.message
+        oe=OpenpayConnectionException.new(exception.message,false)
+        LOG.warn exception.message
+        @errors=true
+        raise  oe
+      #badgateway-connection error, invalid credentials
+      when  RestClient::BadGateway, RestClient::Unauthorized
+            oe=OpenpayConnectionException.new exception.http_body
+            LOG.warn exception.http_body
+            @errors=true
+            raise  oe
+
+      when  RestClient::Exception , RestClient::InternalServerError
+            oe=OpenpayException.new exception.http_body
+            LOG.warn exception.http_body
+            @errors=true
+             raise  oe
+      else
+        #We won't hide unknown exceptions , those should be raised
+        LOG.warn exception.message
+        raise exception
+    end
+  end
+
+
+
+
+
+
+
+end

data/lib/openpay/errors/openpay_transaction_exception.rb

@@ -0,0 +1,5 @@
+require 'openpay/errors/openpay_exception'
+
+class OpenpayTransactionException < OpenpayException
+
+end

data/lib/openpay/fees.rb

@@ -0,0 +1,5 @@
+require 'open_pay_resource'
+
+class Fees < OpenPayResource
+
+end

data/lib/openpay/open_pay_resource.rb

@@ -0,0 +1,242 @@
+
+
+#This class is the abstract base class for other Openpay resources
+#This class defines the basic rest verbs making use of the rest-api gem.
+#Method aliases are created to provide friendly names.
+class OpenPayResource
+
+  attr_accessor :api_hook
+
+  def initialize(merchant_id,private_key,production=false)
+     @merchant_id=merchant_id
+     @private_key=private_key
+     #assigns base url depending the requested env
+     @base_url=OpenpayApi::base_url(production)
+     @errors=false
+    @production=production
+    @timeout=90
+     #created resources should have a hook with the base class to keep control of created resources
+    @api_hook=nil
+  end
+
+
+#returns the env set
+  def  env
+    if @production
+      :production
+    else
+      :test
+    end
+  end
+
+  #errors on last call
+  def errors?
+     @errors
+  end
+
+
+  def list(args='')
+    @base_url+ "#{@merchant_id}/"+ self.class.name.to_s.downcase+"/"+args
+  end
+
+  def each
+    all.each do |line|
+      yield line
+    end
+  end
+
+  def delete_all
+
+    if env == :production
+      raise OpenpayException.new('delete_all method cannot be used on production',false)
+    end
+
+    each do |res|
+      self.delete(res['id'])
+    end
+
+  end
+
+  def get(args='')
+
+    @errors=false
+
+    LOG.debug("#{self.class.name.downcase}:")
+    LOG.debug("   GET Resource URL:#{url(args)}")
+    res=RestClient::Request.new(
+        :method => :get,
+        :url => url(args),
+        :user => @private_key,
+        :timeout => @timeout,
+        :headers => {:accept => :json,
+                     :content_type => :json,
+                     :user_agent => 'Openpay/v1  Ruby-API',
+        }
+    )
+    json_out=nil
+    begin
+      json_out=res.execute
+     #exceptions
+    rescue Exception => e
+      @errors=true
+      #will raise the appropriate exception and return
+      OpenpayExceptionFactory::create(e)
+    end
+
+    JSON[json_out]
+
+  end
+
+ def delete(args)
+
+   @errors=false
+
+   LOG.debug("#{self.class.name.downcase}:")
+   LOG.debug("    DELETE  URL:#{url(args)}")
+
+   res=''
+   req=RestClient::Request.new(
+       :method => :delete,
+       :url => url(args),
+       :user => @private_key,
+       :timeout => @timeout,
+       :headers => {:accept => :json,
+                    :content_type => :json,
+                    :user_agent => 'Openpay/v1  Ruby-API',
+       }
+   )
+
+  begin
+      res=req.execute
+      #exceptions
+  rescue Exception => e
+    @errors=true
+    #will raise the appropriate exception and return
+    OpenpayExceptionFactory::create(e)
+  end
+
+    #returns a hash
+   JSON[res] if not res.empty?
+
+ end
+
+  def post(message,args='')
+
+    return_hash=false
+    @errors=false
+
+    if message.is_a?(Hash)
+      return_hash=true
+      json= hash2json message
+    else
+      json=message
+      return_hash=false
+    end
+
+    LOG.debug("#{self.class.name.downcase}:")
+    LOG.debug "   POST URL:#{url(args)}"
+    #For security reasons we keep it hide
+    #LOG.debug "   json: #{json}"
+
+    begin
+
+    #request
+    res= RestClient::Request.new(
+          :method => :post,
+          :url => url(args) ,
+          :user => @private_key,
+          :timeout => @timeout,
+          :payload => json,
+          :headers => {:accept => :json,
+                       :content_type => :json,
+                       :user_agent => 'Openpay/v1  Ruby-API',
+                       :json => json}
+      ) .execute
+
+    #exceptions
+    rescue Exception => e
+      @errors=true
+      #will raise the appropriate exception and return
+      OpenpayExceptionFactory::create(e)
+    end
+
+    #return
+    if return_hash
+      JSON.parse res
+    else
+      res
+    end
+
+  end
+
+
+
+  def put (message,args='')
+
+    return_hash=false
+
+    if message.is_a?(Hash)
+      return_hash=true
+      json= hash2json message
+    else
+      json=message
+      return_hash=false
+    end
+
+
+    LOG.info "PUT URL:#{url}"
+    #LOG.info "   json: #{json}"
+
+    begin
+      res= RestClient::Request.new(
+          :method => :put,
+          :url => url(args),
+          :user => @private_key,
+          :timeout => @timeout,
+          :payload => json,
+          :headers => {:accept => :json,
+                       :content_type => :json,
+                       :user_agent => 'Openpay/v1  Ruby-API',
+                       :json => json}
+      ) .execute
+    rescue   RestClient::BadRequest  => e
+      warn e.http_body
+      @errors=true
+      return JSON.parse  e.http_body
+    end
+
+
+    if return_hash
+       JSON.parse res
+    else
+       res
+    end
+
+  end
+
+
+  #aliases for rest verbs
+  alias_method :all, :get
+  alias_method :list, :get
+  alias_method :update, :put
+  alias_method  :create , :post
+
+
+  def hash2json(jash)
+    JSON.generate(jash)
+  end
+
+  def json2hash(json)
+    JSON[json]
+  end
+
+
+ private
+  def url(args='')
+    @base_url+"#{@merchant_id}/"+ self.class.name.to_s.downcase+ '/'+args
+  end
+
+
+
+
+end

data/lib/openpay/open_pay_resource_factory.rb

@@ -0,0 +1,10 @@
+class OpenPayResourceFactory
+  def OpenPayResourceFactory::create(resource,merchant_id,private_key,production)
+    begin
+      Object.const_get(resource.capitalize).new(merchant_id,private_key,production)
+    rescue NameError
+         raise OpenpayException.new("Invalid resource name:#{resource}",false)
+    end
+  end
+end
+

data/lib/openpay/openpay_api.rb

@@ -0,0 +1,60 @@
+require 'logger'
+require 'base64'
+require 'rest-client'
+require 'uri'
+
+require 'openpay/open_pay_resource_factory'
+require 'errors/openpay_exception'
+
+LOG= Logger.new(STDOUT)
+#change to Logger::DEBUG if need trace information
+#due the nature of the information, we recommend to never use a log file when in debug
+LOG.level=Logger::ERROR
+
+
+class OpenpayApi
+
+  #API Endpoints
+  API_DEV='https://sandbox-api.openpay.mx/v1/'
+  API_PROD='https://api.openpay.mx'
+
+  #by default the testing environment is used
+  def initialize(merchant_id, private_key,production=false)
+    @merchant_id=merchant_id
+    @private_key=private_key
+    @production=production
+  end
+
+
+  # @return [nil]
+  def create(resource)
+    klass=OpenPayResourceFactory::create(resource, @merchant_id,@private_key,@production)
+    #attach api hook to be able to refere to same API instance from created resources
+    #TODO we may move it to the initialize method
+    klass.api_hook=self
+    klass
+  end
+
+
+  def OpenpayApi::base_url(production)
+    if production
+      API_PROD
+    else
+      API_DEV
+    end
+  end
+
+
+  def  env
+    if @production
+      :production
+    else
+      :test
+    end
+  end
+
+
+
+
+
+end

data/lib/openpay/payouts.rb

@@ -0,0 +1,59 @@
+require 'open_pay_resource'
+
+
+
+class Payouts < OpenPayResource
+
+
+
+
+
+  def all(customer_id=nil)
+    if customer_id
+      customers=@api_hook.create(:customers)
+      customers.all_payouts(customer_id)
+    else
+      super   ''
+    end
+  end
+
+  def get(payout='', customer_id=nil)
+    if customer_id
+      customers=@api_hook.create(:customers)
+      customers.get_payout(customer_id, payout)
+    else
+      super payout
+    end
+  end
+
+
+  def each(customer_id=nil)
+    if customer_id
+      customers=@api_hook.create(:customers)
+      customers.each_payout(customer_id)  do |cust|
+         yield cust
+      end
+    else
+      all.each do |cust|
+        yield cust
+     end
+  end
+
+  end
+
+
+
+
+  def create(payout, customer_id=nil)
+    if customer_id
+      customers=@api_hook.create(:customers)
+      customers.create_payout(customer_id, payout)
+    else
+      super payout
+    end
+  end
+
+
+
+
+end

data/lib/openpay/plans.rb

@@ -0,0 +1,23 @@
+require 'open_pay_resource'
+
+class Plans  < OpenPayResource
+
+  def update(plan,plan_id)
+    put(plan, "#{plan_id}")
+  end
+
+  def each_subscription(plan_id)
+    get("#{plan_id}/subscriptions")
+  end
+
+
+  def all_subscriptions(plan_id)
+    get("#{plan_id}/subscriptions")
+  end
+
+
+  def each
+  end
+
+
+end

data/lib/openpay/subscriptions.rb

@@ -0,0 +1,58 @@
+require 'open_pay_resource'
+
+class Subscriptions  < OpenPayResource
+
+
+
+  def create(subscription,plan_id)
+    customers=@api_hook.create(:customers)
+    customers.create_subscription(subscription,plan_id)
+  end
+
+
+def delete(subscription_id,customer_id)
+  customers=@api_hook.create(:customers)
+  customers.delete_subscription(customer_id, subscription_id)
+end
+
+
+  def get(subscription_id,customer_id)
+
+    customers=@api_hook.create(:customers)
+    customers.get_subscription(customer_id, subscription_id)
+
+  end
+
+
+  def all(customer_id)
+
+    customers=@api_hook.create(:customers)
+    customers.all_subscriptions(customer_id)
+
+  end
+
+
+  def each(customer_id)
+    customers=@api_hook.create(:customers)
+    customers.each_subscription(customer_id) do |c|
+      yield c
+    end
+  end
+
+
+  def delete_all(customer_id)
+    customers=@api_hook.create(:customers)
+    customers.delete_all_subscriptions(customer_id)
+
+  end
+
+
+
+
+
+
+
+
+
+
+end

data/lib/openpay/transfers.rb

@@ -0,0 +1,43 @@
+require 'open_pay_resource'
+
+class  Transfers < OpenPayResource
+
+
+  def create(transfer,customer_id)
+
+      customers=@api_hook.create(:customers)
+      customers.create_transfer(customer_id,transfer)
+
+  end
+
+  def all(customer_id)
+    customers=@api_hook.create(:customers)
+    customers.all_transfers(customer_id)
+  end
+
+
+
+  def get(transfer,customer_id)
+
+    customers=@api_hook.create(:customers)
+    customers.get_transfer(customer_id,transfer)
+
+  end
+
+
+  def each(customer_id)
+    customers=@api_hook.create(:customers)
+    customers.each_transfer(customer_id) do |tran|
+      yield tran
+    end
+
+  end
+
+
+
+
+
+end
+
+
+

data/lib/openpay.rb

@@ -8,7 +8,7 @@ require 'json'
 module Openpay
 
   #api setup / constants
-  require 'openpay/openpay_api'
+  require   'openpay/openpay_api'
 
   #base class
   require  'openpay/open_pay_resource'
@@ -26,9 +26,9 @@ module Openpay
   require 'openpay/charges'
 
   #exceptions
-  require 'openpay/errors/openpay_exception_factory'
-  require 'openpay/errors/openpay_exception'
-  require 'openpay/errors/openpay_transaction_exception'
-  require 'openpay/errors/openpay_connection_exception'
+  require 'errors/openpay_exception_factory'
+  require 'errors/openpay_exception'
+  require 'errors/openpay_transaction_exception'
+  require 'errors/openpay_connection_exception'
 
 end

data/lib/version.rb

@@ -1,6 +1,6 @@
 module Openpay
 
   # Dec 31 2014, 6:00 PM Qro Local time.
-  # 97 test cases passed / 275.232 secs
-  VERSION = '1.0.1'
+  # 97 test cases passed / 220.232 secs
+  VERSION = '1.0.2'
 end

data/openpay.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.version       = Openpay::VERSION
   spec.authors       = ["ronnie_bermejo"]
   spec.email         =  ["ronnie.bermejo.mx@gmail.com"]
-  spec.description   = %q{ruby client for Openpay API services (version 1.0.1)}
+  spec.description   = %q{ruby client for Openpay API services (version 1.0.2)}
   spec.summary       = %q{ruby api for openpay resources}
   spec.homepage      = "http://openpay.mx/"
   spec.license       = "Apache"
@@ -18,9 +18,21 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec)/})
-  spec.require_paths = ["lib","lib/openpay",'openpay']
+  spec.require_paths = ['lib','lib/openpay','openpay','.']
+
+  spec.add_runtime_dependency 'rest-client'  , '~>1.6.7'
+  spec.add_runtime_dependency 'json'
+
+
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'json_spec'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'factory_girl'  ,  '4.2.0'
+  spec.post_install_message = 'Thanks for installing openpay. Enjoy !'
+
+
+
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.post_install_message = "Thanks for installing openpay. Enjoy !"
 end

data/test/spec/bankaccounts_spec.rb

@@ -1,4 +1,4 @@
-require './test/spec_helper'
+require_relative '../spec_helper'
 
 
 describe  Bankaccounts do
@@ -19,7 +19,6 @@ describe  Bankaccounts do
 
   after(:all) do
     @customers.delete_all
-    @bank_accounts.delete_all
   end
 
   describe '.create' do

data/test/spec/cards_spec.rb

@@ -1,4 +1,4 @@
-require './test/spec_helper'
+require_relative '../spec_helper'
 
 
 describe Cards do

data/test/spec/charges_spec.rb

@@ -1,5 +1,4 @@
-
-require './test/spec_helper'
+require_relative '../spec_helper'
 
 describe Charges do
 

data/test/spec/customers_spec.rb

@@ -1,4 +1,4 @@
-require './test/spec_helper'
+require_relative '../spec_helper'
 
 
 describe Customers do
@@ -200,7 +200,7 @@ describe Customers do
       end
 
       #performs check
-      expect(@customers.all.size).to be 5
+      expect(@customers.all.size).to be > 4
       @customers.delete_all
       expect(@customers.all.size).to be 0
     end

data/test/spec/exceptions_spec.rb

@@ -1,4 +1,4 @@
-require './test/spec_helper'
+require_relative '../spec_helper'
 
 
 describe 'Openpay Exceptions' do