besepa 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e725ca7cd7ea944a8c13d88162899de00290ba13
+  data.tar.gz: 7902ef96eef5551d51a360dac0954222511e4e29
+SHA512:
+  metadata.gz: becde3ce5f9e41fa12b887b8abe3f5b8ae52fe7b51be1069a98f0f9b6ecabbba2f37c88788aee846fc160442f3f433b7d961cebfa1e6d025af538f42dbac20ac
+  data.tar.gz: ff2577c252329c1071e03589d1e065a3c70a8b26220a6e06a29e63cc30d17bf8279c151bdfadac62d82fd5ded4a6c85075b4908626f7518adc219556bd13d178

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in besepa-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    besepa (0.2)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    multipart-post (2.0.0)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    safe_yaml (1.0.4)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  besepa!
+  bundler (~> 1.3)
+  rake
+  rspec (~> 3.1)
+  webmock (~> 1.20)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alberto Molpeceres
+
+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,132 @@
+# Besepa::Ruby
+
+A Ruby gem to Besepa.com's API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'besepa-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install besepa-ruby
+    
+## Documentation
+
+http://apidocs.besepa.com
+
+
+## Configuration
+
+```ruby
+Besepa.configure do |config|
+  config.api_key = API_KEY 
+  config.endpoint = API_END_POINT
+end
+```
+
+By default, this gem points to Besepa's sandbox (https://sandbox.besepa.com). If you want to point to Besepa's production environment, use https://api.besepa.com as endpoint.
+
+Remeber that API_KEY changes from one environment to the other.
+
+## Usage
+
+**Get all customers**
+
+```ruby
+Besepa::Customer.all
+```
+
+**Get one customer's information**
+
+```ruby
+Besepa::Customer.find( customer_id  )
+```
+
+**Update customer**
+
+```ruby
+c = Besepa::Customer.find( customer_id  )
+c.name = 'New name'
+c.save
+```
+
+**Remove customer**
+
+```ruby
+c = Besepa::Customer.find( customer_id  )
+c.destroy #customer's state is change to 'REMOVED'
+```
+
+Note all subscriptions, upcoming debits and mandates for this customer will be cancelled
+
+
+**Get customer's bank accounts**
+
+```ruby
+Besepa::Customer.find( customer_id  ).bank_accounts
+```
+
+In case you don't have a Customer yet, just create one Customer object with it's id.
+```ruby
+Besepa::Customer.new( id: customer_id  ).bank_accounts
+```
+
+**Get customer's subscriptions**
+
+```ruby
+Besepa::Customer.new( id: customer_id  ).subscriptions
+```
+
+**Get customer's debits**
+
+```ruby
+Besepa::Customer.new( id: customer_id  ).debits
+```
+
+**Add a bank account to a customer**
+
+```ruby
+Besepa::Customer.new( id: customer_id  ).add_bank_account(iban, bic, bank_name)
+
+```
+bank_name is optional.
+
+**Create a debit for a customer**
+
+```ruby
+Besepa::Customer.new( id: customer_id  ).add_debit(bank_account_id, reference, description, amount, collect_at, creditor_account_id, metadata)
+```
+
+Amount is with two decimals, without separation character (1000 == 10.00)
+Metadata can be a hash that we will store associated to this debit. creditor_account_id is optional, if none passed, we will use account's default one. 
+
+
+
+
+
+
+
+
+
+## Supported Ruby Versions
+
+Right now, this gem has been tested with Ruby 2 only. More coming.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## Copyright
+
+Copyright (c) 2015 Besepa Technologies S.L.. See LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/besepa-ruby.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'besepa/utils/version'
+
+Gem::Specification.new do |spec|
+  
+  spec.name          = "besepa"
+  spec.version       = Besepa::Utils::VERSION
+  spec.authors       = ["besepa.com"]
+  spec.email         = ["alberto@besepa.com"]
+  spec.description   = %q{Ruby client for besepa.com}
+  spec.summary       = %q{Ruby client for besepa.com}
+  spec.homepage      = "http://www.besepa.com"
+  spec.license       = "MIT"
+
+  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|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('faraday', '~> 0.9')
+  spec.add_dependency('faraday_middleware', '~> 0.9')
+    
+  spec.add_development_dependency "bundler", "~> 1.3"
+  
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'webmock', '~> 1.20'
+  spec.add_development_dependency "rake"
+    
+end

data/lib/besepa.rb

@@ -0,0 +1,14 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+Dir.glob(File.join(libdir, 'besepa', 'utils','*.rb')).each {|f| require f }
+Dir.glob(File.join(libdir, 'besepa', 'api_calls','*.rb')).each {|f| require f }
+require File.join(libdir, 'besepa', 'errors', 'besepa_error.rb')
+Dir.glob(File.join(libdir, 'besepa', 'errors','*.rb')).each {|f| require f }
+require File.join(libdir, 'besepa', 'resource.rb')
+Dir.glob(File.join(libdir, 'besepa', '*.rb')).each {|f| require f }
+
+module Besepa
+
+  extend Utils::ApiConfig
+
+end

data/lib/besepa/activity.rb

@@ -0,0 +1,11 @@
+module Besepa
+
+  class Activity < Besepa::Resource
+        
+    FIELDS = [:id, :key, :created_at, :owner]
+    FIELDS.each do |f|
+      attr_accessor f
+    end    
+      
+  end
+end

data/lib/besepa/api_calls/create.rb

@@ -0,0 +1,26 @@
+module Besepa
+    
+  module ApiCalls
+    
+    module Create
+
+      module ClassMethods
+        
+        def create(params, filters={})
+          payload = {}
+          payload[klass_name] = params
+          response = post "/#{api_path(filters)}", payload
+          self.new(response['response'])
+        end
+        
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    
+    end
+    
+  end
+  
+end

data/lib/besepa/api_calls/destroy.rb

@@ -0,0 +1,15 @@
+module Besepa
+    
+  module ApiCalls
+    
+    module Destroy
+      
+      def destroy(filters={})
+        response = delete "/#{self.class.api_path(filters)}/#{id}"
+        process_attributes(response['response']) if response['response']
+        self
+      end
+      
+    end
+  end
+end

data/lib/besepa/api_calls/list.rb

@@ -0,0 +1,36 @@
+module Besepa
+    
+  module ApiCalls
+    
+    module List
+
+      module ClassMethods
+        
+        def all(filters={})
+          response = get "/#{api_path(filters)}"
+          objects = Array.new
+          if response['count'] > 0
+            response['response'].each do |c|
+              objects << self.new(c)
+            end
+          end
+          objects
+        end
+        
+        def find(id, filters={})
+          response = get "/#{api_path(filters)}/#{id}"
+          c = self.new(response['response'])
+          c
+        end
+        
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    
+    end
+    
+  end
+  
+end

data/lib/besepa/api_calls/update.rb

@@ -0,0 +1,23 @@
+module Besepa
+    
+  module ApiCalls
+    
+    module Update
+      
+      def save(filters={})
+        h = self.to_hash
+        #id and status should not be send back to the server
+        h.delete(:status) 
+        h.delete(:id)
+        #remove all nil values. Not updated.
+        h.delete_if {|key, value| value.nil? }
+        payload = {}
+        payload[self.class.klass_name] = h
+        response = put "/#{self.class.api_path(filters)}/#{id}", payload
+        process_attributes(response['response'])
+        self
+      end
+      
+    end
+  end
+end

data/lib/besepa/bank_account.rb

@@ -0,0 +1,63 @@
+module Besepa
+
+  class BankAccount < Besepa::Resource
+    
+    include Besepa::ApiCalls::List
+    include Besepa::ApiCalls::Create
+    include Besepa::ApiCalls::Update
+    include Besepa::ApiCalls::Destroy
+            
+    FIELDS = [:id, :iban, :bic, :bank_name, :status, :customer_id]  
+    
+    FIELDS.each do |f|
+      attr_accessor f
+    end   
+
+    attr_accessor :mandate
+        
+    def self.klass_name
+      "bank_account"
+    end
+
+    def set_as_default
+      response = put "/#{api_path({customer_id: customer_id})}/set_as_default"
+      process_attributes(response['response'])
+      self
+    end
+    
+    def generate_signature_request
+      response = put "/#{api_path({customer_id: customer_id})}/generate_signature_request"
+      process_attributes(response['response'])
+      self
+    end
+    
+    def to_hash
+      values = {}
+      self.class::FIELDS.each do |key|
+        values[key] = self.send("#{key.to_s}")
+      end
+      values[:mandate] = mandate.to_hash if mandate
+      values
+    end
+    
+    protected
+    
+      def self.api_path(filters={})
+        "#{Customer.api_path}/#{CGI.escape(filters[:customer_id])}/bank_accounts"
+      end
+
+      def api_path(filters={})
+        "#{Customer.api_path}/#{CGI.escape(filters[:customer_id]||customer_id)}/bank_accounts/#{CGI.escape(id)}"
+      end
+    
+      def process_attributes(attrs)
+        self.class::FIELDS.each do |key|
+          self.send("#{key.to_s}=", attrs[key.to_s] || attrs[key.to_sym])
+        end
+        self.mandate = Besepa::Mandate.new(attrs['mandate']) if attrs['mandate']
+        process_activities(attrs)
+        self
+      end
+
+  end
+end