broke 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d5952063ed7ee816901a359f848d4a7367cf958
+  data.tar.gz: 95971d9aa1f4cb9341f3a485549daf4dcb023f74
+SHA512:
+  metadata.gz: 3c9ba2b289f7d4b0a1fced74e1e2dbc0455c4c263f0ba56e90dd0e4c66e525066ce1b68cd255b53731d174227ff30dc11b1a0152998627bd657177c16a544b0f
+  data.tar.gz: 39d3509f0586c1d1279adf0189dbdebe1e3425a4fc5e45f380d9771f872ccccfeccb984ef781af461d83218837dc540128d38cbe5adf9996e349f4a914f12a91

data/lib/broke.rb

@@ -0,0 +1,51 @@
+require 'faraday'
+require 'faraday_middleware'
+
+class Broke
+
+  class << self
+    attr_accessor :api_key
+  end
+
+  def initialize api_key
+    @@api_key = api_key
+    @@conn = Faraday.new(:url => 'https://api.paymentwall.com/api') do |conn|
+      conn.request  :url_encoded
+      conn.response :json, :content_type => 'application/json'
+      conn.adapter  Faraday.default_adapter
+    end
+  end
+
+  def charge
+    Charge.new
+  end
+
+  def subscription
+    Subscription.new
+  end
+
+  def pingback
+    Pingback
+  end
+
+  private
+
+  def get path
+    @@conn.get do |req|
+      req.headers['X-ApiKey'] = @@api_key
+      req.url path
+    end
+  end
+
+  def post path, params
+    @@conn.post do |req|
+      req.headers['X-ApiKey'] = @@api_key
+      req.url path
+      req.body = params
+    end
+  end
+end
+
+require 'broke/subscription'
+require 'broke/charge'
+require 'broke/pingback'

data/lib/broke/charge.rb

@@ -0,0 +1,24 @@
+class Broke::Charge < Broke
+
+  def initialize; end
+
+  def create params
+    post 'brick/charge', params
+  end
+
+  def details charge_id
+    get "brick/charge/#{charge_id}"
+  end
+
+  def refund charge_id
+    get "brick/charge/#{charge_id}/refund"
+  end
+
+  def capture charge_id
+    get "brick/charge/#{charge_id}/capture"
+  end
+
+  def void charge_id
+    get "brick/charge/#{charge_id}/void"
+  end
+end

data/lib/broke/pingback.rb

@@ -0,0 +1,197 @@
+class Broke::Pingback < Broke
+
+  PINGBACK_TYPE_REGULAR = 0
+  PINGBACK_TYPE_GOODWILL = 1
+  PINGBACK_TYPE_NEGATIVE = 2
+  
+  def initialize(parameters = {}, ipAddress = '')
+    @parameters = parameters
+    @ipAddress = ipAddress
+  end
+
+  def validate(skipIpWhitelistCheck = false)
+    validated = false
+
+    if self.isParametersValid()
+      if self.isIpAddressValid() || skipIpWhitelistCheck
+        if self.isSignatureValid()
+          validated = true
+        else 
+          self.appendToErrors('Wrong signature')
+        end
+      else
+        self.appendToErrors('IP address is not whitelisted')
+      end
+    else
+      self.appendToErrors('Missing parameters')
+    end
+
+    validated
+  end
+
+  def isSignatureValid()
+    signatureParamsToSign = {}
+
+    if self.class::getApiType() == self.class::API_VC
+      signatureParams = Array['uid', 'currency', 'type', 'ref']
+    elsif self.class::getApiType() == self.class::API_GOODS
+      signatureParams = Array['uid', 'goodsid', 'slength', 'speriod', 'type', 'ref']
+    else
+      signatureParams = Array['uid', 'goodsid', 'type', 'ref']
+      @parameters['sign_version'] = self.class::SIGNATURE_VERSION_2
+
+    end
+
+    if !@parameters.include?('sign_version') || @parameters['sign_version'].to_i == self.class::SIGNATURE_VERSION_1
+      signatureParams.each do |field|
+        signatureParamsToSign[field] = @parameters.include?(field) ? @parameters[field] : nil
+      end
+      
+      @parameters['sign_version'] = self.class::SIGNATURE_VERSION_1
+
+    else
+      signatureParamsToSign = @parameters
+    end
+
+    signatureCalculated = self.calculateSignature(signatureParamsToSign, self.class::api_key, @parameters['sign_version'])
+    
+    signature = @parameters.include?('sig') ? @parameters['sig'] : nil
+
+    signature == signatureCalculated
+  end
+
+  def isIpAddressValid()
+    ipsWhitelist = [
+      '174.36.92.186',
+      '174.36.96.66',
+      '174.36.92.187',
+      '174.36.92.192',
+      '174.37.14.28'
+    ]
+
+    ipsWhitelist.include? @ipAddress
+  end
+
+  def isParametersValid()
+    errorsNumber = 0
+    requiredParams = []
+
+    if self.class::getApiType() == self.class::API_VC
+      requiredParams = ['uid', 'currency', 'type', 'ref', 'sig']
+    elsif self.class::getApiType() == self.class::API_GOODS
+      requiredParams = ['uid', 'goodsid', 'type', 'ref', 'sig']
+    else
+      requiredParams = ['uid', 'goodsid', 'type', 'ref', 'sig']
+    end
+
+    requiredParams.each do |field|
+      if !@parameters.include?(field) # || $parameters[field] === ''
+        self.appendToErrors("Parameter #{field} is missing")
+        errorsNumber += 1
+      end
+    end
+
+    errorsNumber == 0
+  end
+
+  def getParameter(param)
+    if @parameters.include?(param)
+      return @parameters[param]
+    else 
+      return nil
+    end
+  end
+
+  def getType()
+    pingbackTypes = [
+      self.class::PINGBACK_TYPE_REGULAR,
+      self.class::PINGBACK_TYPE_GOODWILL,
+      self.class::PINGBACK_TYPE_NEGATIVE
+    ]
+
+    if @parameters.include?('type')
+      if pingbackTypes.include?(@parameters['type'].to_i)
+        return @parameters['type'].to_i
+      end
+    end
+
+    return nil
+  end
+
+  def getUserId
+    self.getParameter('uid').to_s
+  end
+
+  def getVirtualCurrencyAmount()
+    self.getParameter('currency').to_i
+  end
+
+  def getProductId()
+    self.getParameter('goodsid').to_s
+  end
+
+  def getProductPeriodLength()
+    self.getParameter('slength').to_i
+  end
+
+  def getProductPeriodType()
+    self.getParameter('speriod').to_s
+  end
+
+  def getReferenceId()
+    self.getParameter('ref').to_s
+  end
+
+  def getPingbackUniqueId()
+    self.getReferenceId().to_s + '_' + self.getType().to_s
+  end
+
+  def isDeliverable()
+    self.getType() == self.class::PINGBACK_TYPE_REGULAR || self.getType() == self.class::PINGBACK_TYPE_GOODWILL
+  end
+
+  def isCancelable()
+    self.getType() == self.class::PINGBACK_TYPE_NEGATIVE
+  end
+
+  protected
+
+  def calculateSignature(params, secret, version)
+    
+    params = params.clone
+    params.delete('sig')
+
+    sortKeys = (version.to_i == self.class::SIGNATURE_VERSION_2 or version.to_i == self.class::SIGNATURE_VERSION_3)
+    keys = sortKeys ? params.keys.sort : params.keys
+
+    baseString = ''
+
+    keys.each do |name| 
+      p = params[name]
+
+      # converting array to hash
+      if p.kind_of?(Array)
+        p = Hash[p.map.with_index { |key, value| [value, key] }]
+      end
+
+      if p.kind_of?(Hash)
+        subKeys = sortKeys ? p.keys.sort : p.keys;
+        subKeys.each do |key|
+          value = p[key] 
+          baseString += "#{name}[#{key}]=#{value}"
+        end
+      else
+        baseString += "#{name}=#{p}"
+      end
+    end
+
+    baseString += secret
+
+    require 'digest'
+    if version.to_i == self.class::SIGNATURE_VERSION_3
+      return Digest::SHA256.hexdigest(baseString)
+    else 
+      return Digest::MD5.hexdigest(baseString)
+    end
+  end
+end

data/lib/broke/subscription.rb

@@ -0,0 +1,16 @@
+class Broke::Subscription < Broke
+
+  def initialize; end
+
+  def create params
+    post 'brick/subscription', params
+  end
+
+  def details subscription_id
+    get "brick/subscription/#{subscription_id}"
+  end
+
+  def cancel subscription_id
+    get "brick/subscription/#{subscription_id}/cancel"
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: broke
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Youssef Kababe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: Simple Ruby library to interact with Paymentwall's Brick API
+email: hello@youssefkababe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/broke.rb
+- lib/broke/charge.rb
+- lib/broke/pingback.rb
+- lib/broke/subscription.rb
+homepage: https://github.com/YoussefKababe/broke
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Paymentwall's Brick API Ruby library
+test_files: []