fidor_api 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b18d0f77a280f02bee3ddf6b2bce5a3c4d598644
-  data.tar.gz: 820e2789982d1376be43f2b95be4c4e448c25902
+  metadata.gz: e901a140ae4373b030fc1acd73b528139ef6661f
+  data.tar.gz: a0cc6f973f426c1c28da0d44c2b845f79a33cf05
 SHA512:
-  metadata.gz: a69f553f0953fb1967527fb58e50db7d4903fc39087ddfbc89d8d2f7cb3e0c8e50546b9a7c87f3d6b7f9da05b4ef5e1b4f7ec03cae0a68c69078570089224c39
-  data.tar.gz: 06e0802e771bcf251e7d8ef8e0f7f5e9be435740702c5fc7f74a5e1eae30ef584529a368cbac37d481e34872b744ba517ef90cec6dd4bc713846801314001688
+  metadata.gz: a303081e9be0a99ba14e063609a3047ca4dd2db7e9765bc8aeea4cbf4142d9dd2d5f71d5d3b8527131ece88c268105c510d46af0689144d5e5d436268cf7d869
+  data.tar.gz: 5ef3b95906b997d771ac9e44687ce3a3d5101585d33f90b2d5282226da026b47c2cbf7c3611a5ce7d47ad4dbd11a79cbfe18a9069fa740690bd0030c17e24287

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .byebug_history
+vcr.log

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.4.0

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
 rvm:
-  - "2.1.10"
-  - "2.2.5"
-  - "2.3.1"
+  - "2.2.6"
+  - "2.3.3"
+  - "2.4.0"
 addons:
   code_climate:
     repo_token: 2ffd456a223e8c95dbd79a25a5ea3dca9899ece93fce3cfdfae3723a76f0028e
+before_install:
+  - gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,114 @@
+# Changelog
+
+## v0.1.0
+
+With this release this gem will start following the semantic versioning approach.
+
+**Note**: This version contains two major changes which will break existing applications:
+
+### How to initiate the client:
+
+Before:
+
+```ruby
+client = FidorApi::Client.new(token: FidorApi::Token.new(access_token: "f859032a6ca0a4abb2be0583b8347937"))
+```
+
+After:
+
+```
+FidorApi::Connectivity.access_token = "f859032a6ca0a4abb2be0583b8347937"
+```
+
+### How to create resources:
+
+Before:
+
+```ruby
+transfer = client.build_internal_transfer(
+  account_id:   875,
+  receiver:     "kycfull@fidor.de",
+  external_uid: "4279762F5",
+  subject:      "Money for you",
+  amount:       1000
+)
+transfer.save
+```
+
+After:
+
+```ruby
+transfer = FidorApi::Transfer::Internal.new(
+  account_id:   875,
+  receiver:     "kycfull@fidor.de",
+  external_uid: "4279762F5",
+  subject:      "Money for you",
+  amount:       1000
+)
+transfer.save
+```
+
+* Also map errors returned on the `:base` field
+* Support for `/transfers` and `/beneficiaries` endpoints` with routing types: (*Note*: Not supported in fidor.de & fidorbank.uk APIs)
+  * `ACH`
+  * `BANK_INTERNAL`
+  * `FOS_P2P_ACCOUNT_NUMBER`
+  * `FOS_P2P_PHONE`
+  * `FOS_P2P_USERNAME`
+  * `SWIFT`
+  * `UTILITY`
+* Improve logger setup
+  * Add new `logger` config option to pass existing logger
+  * Add support for `faraday-detailed_logger` gem without adding additional dependency
+* Support for `/confirmable/actions` endpoint
+* New option `verify_ssl` (needed when testing against e.g. mock-services or fidor-internal test installations)
+* Logging for `FidorApi::ClientError` cases
+* New fields for contact- & bank-details in `/transfers` endpoint
+* Support for `/session_tokens` endpoint
+* Support for `/beneficiaries` endpoint
+* Provide `total_entries` attribute in collections
+* Support for `/messages/:id/content` endpoint
+* Support for updating customer records
+* New fields for customer endpoint
+* Support Address attribute in cards endpoint
+* Handle HTTP 303 with exception indicating the need to use confirmable-action
+* Add unique_name attribute to beneficiaries
+* Add support to activate and cancel cards
+* Better mapping of error keys to support usage of i18n
+* Suport for endpoints to reset & change password
+* New way to build ressources (using `FidorApi::Transfers::ACH.new` instead of `client.build_ach_transfer`)
+* Allow to update customers
+* Improved Ruby 2.4 compatibility
+
+## v0.0.2
+
+All commits: https://github.com/klausmeyer/fidor_api/compare/v0.0.1...v0.0.2
+
+* Gem can now be used in rails 5 projects
+* `FidorApi::Client` added to improve token-management
+* `remote_bic` field optional in `Transfer::SEPA`
+* Amounts are now `BigDecimal` type
+* `Resource#model_name` returns `Resource` instead of `FidorApi::Resource` now
+* Collection implements `Enumerable`
+* `Resource#persisted?` added to improve `ActiveRecord` style behaviour
+* `Customer#gender` now returns `FidorApi::Customer::Gender`
+* Basic support for signup (`Msisdn`, `Customer#save`)
+* Support new endpoints
+  * `/cards`
+  * `/card_limits`
+  * `/messages`
+  * `/fps_payments` (:gb: specific)
+* Provide validation errors returned in API in `Resource#errors`
+
+## v0.0.1
+
+* First release on rubygems.org
+* oAuth support
+* Basic support for the following endpoints:
+  * `/accounts`
+  * `/customers`
+  * `/preauths`
+  * `/transactions`
+  * `/internal_transfers`
+  * `/sepa_credit_transfers`
+  * `/users/current`

data/Gemfile

@@ -8,7 +8,8 @@ group :development, :test do
   gem "rake", "~> 10.0"
   gem "rspec", "~> 3.3"
   gem "shoulda-matchers", "~> 2.8"
-  gem "vcr", "~> 2.9"
-  gem "simplecov", "~> 0.10"
+  gem "vcr", "~> 3.0"
+  gem "webmock"
+  gem "simplecov", github: "colszowka/simplecov"
   gem "codeclimate-test-reporter", group: :test, require: nil
 end

data/README.md

@@ -69,13 +69,12 @@ end
 ### 2. Fetching data
 
 ```ruby
-token = FidorApi::Token.new(access_token: "f859032a6ca0a4abb2be0583b8347937")
+FidorApi::Connectivity.access_token = "f859032a6ca0a4abb2be0583b8347937"
 
-client = FidorApi::Client.new(token: token)
-user = client.current_user
+user = FidorApi::User.current
 # => FidorApi::User
 
-transactions = client.transactions
+transactions = FidorApi::Transaction.all
 # => FidorApi::Collection
 
 transaction = transactions.first
@@ -85,11 +84,9 @@ transaction = transactions.first
 ### 3. Creating transfers
 
 ```ruby
-token = FidorApi::Token.new(access_token: "f859032a6ca0a4abb2be0583b8347937")
+FidorApi::Connectivity.access_token = "f859032a6ca0a4abb2be0583b8347937"
 
-client = FidorApi::Client.new(token: token)
-
-transfer = client.build_internal_transfer(
+transfer = FidorApi::Transfer::Internal.new(
   account_id:   875,
   receiver:     "kycfull@fidor.de",
   external_uid: "4279762F5",
@@ -99,7 +96,9 @@ transfer = client.build_internal_transfer(
 # => FidorApi::Transfer::Internal
 
 transfer.save
-# => true / or raise error
+# => true
+# or
+# => false and `transfer.errors` containing details
 ```
 
 ## Development
@@ -112,7 +111,10 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/klausmeyer/fidor_api.
 
+## Changelog
+
+Have a look at the [CHANGELOG](CHANGELOG.md) for details.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/fidor_api/account.rb

@@ -1,9 +1,10 @@
 module FidorApi
-
-  class Account < Resource
+  class Account < Connectivity::Resource
     extend ModelAttribute
     extend AmountAttributes
 
+    self.endpoint = Connectivity::Endpoint.new('/accounts', :collection)
+
     attribute :id,                    :integer
     attribute :account_number,        :string
     attribute :iban,                  :string
@@ -22,12 +23,8 @@ module FidorApi
     amount_attribute :cash_flow_per_year
     amount_attribute :overdraft
 
-    def self.all(access_token, options = {})
-      Collection.build(self, request(access_token: access_token, endpoint: "/accounts", query_params: options).body)
-    end
-
-    def self.first(access_token)
-      all(access_token, page: 1, per_page: 1).first
+    def self.first
+      all(page: 1, per_page: 1).first
     end
 
     def customers=(array)
@@ -36,11 +33,11 @@ module FidorApi
 
     module ClientSupport
       def accounts(options = {})
-        Account.all(token.access_token, options)
+        Account.all(options)
       end
 
       def first_account
-        Account.first(token.access_token)
+        Account.first
       end
     end
   end

data/lib/fidor_api/amount_attributes.rb

@@ -1,27 +1,30 @@
-module AmountAttributes
-  def self.extended(base)
-    base.instance_variable_set('@amount_attributes', [])
-  end
-
-  def amount_attribute(name)
-    @amount_attributes << name
+module FidorApi
+  module AmountAttributes
 
-    define_method name do
-      BigDecimal.new((instance_variable_get("@#{name}") / 100.00).to_s) if instance_variable_get("@#{name}").present?
+    def self.extended(base)
+      base.instance_variable_set('@amount_attributes', [])
     end
 
-    define_method "#{name}=" do |value|
-      if value.instance_of?(BigDecimal)
-        instance_variable_set("@#{name}", (value * 100.00).to_i)
-      elsif value.instance_of?(Fixnum) || value.instance_of?(NilClass)
-        instance_variable_set("@#{name}", value)
-      else
-        raise ArgumentError, "Must be either Fixnum (1234) or BigDecimal (12.34)."
+    def amount_attribute(name)
+      @amount_attributes << name
+
+      define_method name do
+        BigDecimal.new((instance_variable_get("@#{name}") / 100.00).to_s) if instance_variable_get("@#{name}").present?
+      end
+
+      define_method "#{name}=" do |value|
+        if value.instance_of?(BigDecimal)
+          instance_variable_set("@#{name}", (value * 100.00).to_i)
+        elsif value.class.name.in?(INTEGER_CLASSES) || value.instance_of?(NilClass)
+          instance_variable_set("@#{name}", value)
+        else
+          raise ArgumentError, "Must be either Fixnum (1234) or BigDecimal (12.34)."
+        end
       end
     end
-  end
 
-  def attributes
-    super + @amount_attributes
+    def attributes
+      super + @amount_attributes
+    end
   end
-end
+end

data/lib/fidor_api/approval_required.rb

@@ -0,0 +1,9 @@
+module FidorApi
+  class ApprovalRequired < RuntimeError
+    attr_reader :confirmable_action
+
+    def initialize(confirmable_action)
+      @confirmable_action = confirmable_action
+    end
+  end
+end

data/lib/fidor_api/auth.rb

@@ -28,7 +28,7 @@ module FidorApi
     private
 
     def connection
-      Faraday.new(url: FidorApi.configuration.oauth_url) do |config|
+      Faraday.new(url: FidorApi.configuration.oauth_url, ssl: { verify: FidorApi.configuration.verify_ssl }) do |config|
         config.use      Faraday::Request::BasicAuthentication, FidorApi.configuration.client_id, FidorApi.configuration.client_secret
         config.request  :url_encoded
         config.response :logger if FidorApi.configuration.logging

data/lib/fidor_api/beneficiary/ach.rb

@@ -0,0 +1,39 @@
+module FidorApi
+  module Beneficiary
+    class ACH < Base
+      include Generic
+
+      attribute :account_number, :string
+      attribute :routing_code,   :string
+
+      validates :contact_name,   presence: true
+      validates :account_number, presence: true
+      validates :routing_code,   presence: true
+
+      def set_attributes(attrs = {})
+        self.account_number = attrs.fetch("routing_info", {})["account_number"]
+        self.routing_code   = attrs.fetch("routing_info", {})["routing_code"]
+        super(attrs.except("routing_type", "routing_info"))
+      end
+
+      def as_json_routing_type
+        "ACH"
+      end
+
+      def as_json_routing_info
+        {
+          account_number: account_number,
+          routing_code:   routing_code
+        }
+      end
+
+      private
+
+      module ClientSupport
+        def build_ach_beneficiary(attributes = {})
+          Beneficiary::ACH.new(attributes)
+        end
+      end
+    end
+  end
+end

data/lib/fidor_api/beneficiary/base.rb

@@ -0,0 +1,118 @@
+module FidorApi
+  module Beneficiary
+    class Base < Connectivity::Resource
+      ROUTING_INFO_ERROR_PREFIX = "routing_info.".freeze
+
+      self.endpoint = Connectivity::Endpoint.new('/beneficiaries', :collection)
+
+      attr_accessor :confirmable_action
+
+      class << self
+        def new(hash={})
+          if self == Base
+            class_for_response_hash(hash).new hash
+          else
+            super
+          end
+        end
+
+        def delete(id)
+          endpoint.for(new(id: id)).delete
+          true
+        end
+
+        private
+
+        def class_for_response_hash(hash)
+          {
+            "FOS_P2P_ACCOUNT_NUMBER" => FidorApi::Beneficiary::P2pAccountNumber,
+            "FOS_P2P_PHONE"          => FidorApi::Beneficiary::P2pPhone,
+            "FOS_P2P_USERNAME"       => FidorApi::Beneficiary::P2pUsername,
+            "SWIFT"                  => FidorApi::Beneficiary::Swift,
+            "UTILITY"                => FidorApi::Beneficiary::Utility
+          }.fetch(hash["routing_type"], FidorApi::Beneficiary::Unknown)
+        end
+      end
+
+      def set_attributes(attrs = {})
+        self.contact_name           = attrs.fetch("contact", {})["name"]
+        self.contact_address_line_1 = attrs.fetch("contact", {})["address_line_1"]
+        self.contact_address_line_2 = attrs.fetch("contact", {})["address_line_2"]
+        self.contact_city           = attrs.fetch("contact", {})["city"]
+        self.contact_country        = attrs.fetch("contact", {})["country"]
+
+        self.bank_name              = attrs.fetch("bank",    {})["name"]
+        self.bank_address_line_1    = attrs.fetch("bank",    {})["address_line_1"]
+        self.bank_address_line_2    = attrs.fetch("bank",    {})["address_line_2"]
+        self.bank_city              = attrs.fetch("bank",    {})["city"]
+        self.bank_country           = attrs.fetch("bank",    {})["country"]
+
+        super(attrs.except("contact", "bank", "routing_type", "routing_info"))
+      end
+
+      def save
+        fail InvalidRecordError unless valid?
+        super
+      end
+
+      def as_json
+        {
+          account_id:  account_id,
+          unique_name: unique_name,
+          contact: {
+            name:           contact_name,
+            address_line_1: contact_address_line_1,
+            address_line_2: contact_address_line_2,
+            city:           contact_city,
+            country:        contact_country
+          }.compact,
+          bank: {
+            name:           bank_name,
+            address_line_1: bank_address_line_1,
+            address_line_2: bank_address_line_2,
+            city:           bank_city,
+            country:        bank_country
+          }.compact,
+          routing_type: as_json_routing_type,
+          routing_info: as_json_routing_info
+        }.compact
+      end
+
+      private
+
+      def remote_create
+        response = super
+        if path = response.headers["X-Fidor-Confirmation-Path"]
+          self.confirmable_action = ConfirmableAction.new(id: path.split("/").last)
+        end
+        response
+      end
+
+      def remote_update(*attributes)
+        response = super
+        if path = response.headers["X-Fidor-Confirmation-Path"]
+          self.confirmable_action = ConfirmableAction.new(id: path.split("/").last)
+        end
+        response
+      end
+
+      def map_errors(fields)
+        fields.each do |hash|
+          field = hash["field"].to_sym
+          key   = hash["key"].try :to_sym
+
+          if field == :base || respond_to?(field)
+            if key
+              errors.add(field, key, message: hash["message"])
+            else
+              errors.add(field, hash["message"])
+            end
+          elsif hash["field"].start_with?(ROUTING_INFO_ERROR_PREFIX)
+            invalid_field = hash["field"][ROUTING_INFO_ERROR_PREFIX.size..-1]
+            errors.add(invalid_field, hash["key"].to_sym, message: hash["message"])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fidor_api/beneficiary/generic.rb

@@ -0,0 +1,24 @@
+module FidorApi
+  module Beneficiary
+    module Generic
+      def self.included(base)
+        base.extend ModelAttribute
+
+        base.attribute :id,                     :string
+        base.attribute :account_id,             :string
+        base.attribute :unique_name,            :string
+        base.attribute :contact_name,           :string
+        base.attribute :contact_address_line_1, :string
+        base.attribute :contact_address_line_2, :string
+        base.attribute :contact_city,           :string
+        base.attribute :contact_country,        :string
+        base.attribute :bank_name,              :string
+        base.attribute :bank_address_line_1,    :string
+        base.attribute :bank_address_line_2,    :string
+        base.attribute :bank_city,              :string
+        base.attribute :bank_country,           :string
+        base.attribute :verified,               :boolean
+      end
+    end
+  end
+end

data/lib/fidor_api/beneficiary/p2p_account_number.rb

@@ -0,0 +1,14 @@
+module FidorApi
+  module Beneficiary
+    class P2pAccountNumber < Base
+      include Generic
+
+      attribute :account_number, :string
+
+      def set_attributes(attrs = {})
+        self.account_number = attrs.fetch("routing_info", {})["account_number"]
+        super(attrs.except("routing_type", "routing_info"))
+      end
+    end
+  end
+end

data/lib/fidor_api/beneficiary/p2p_phone.rb

@@ -0,0 +1,14 @@
+module FidorApi
+  module Beneficiary
+    class P2pPhone < Base
+      include Generic
+
+      attribute :mobile_phone_number, :string
+
+      def set_attributes(attrs = {})
+        self.mobile_phone_number = attrs.fetch("routing_info", {})["mobile_phone_number"]
+        super(attrs.except("routing_type", "routing_info"))
+      end
+    end
+  end
+end

data/lib/fidor_api/beneficiary/p2p_username.rb

@@ -0,0 +1,14 @@
+module FidorApi
+  module Beneficiary
+    class P2pUsername < Base
+      include Generic
+
+      attribute :username, :string
+
+      def set_attributes(attrs = {})
+        self.username = attrs.fetch("routing_info", {})["username"]
+        super(attrs.except("routing_type", "routing_info"))
+      end
+    end
+  end
+end

data/lib/fidor_api/beneficiary/swift.rb

@@ -0,0 +1,35 @@
+module FidorApi
+  module Beneficiary
+    class Swift < Base
+      include Generic
+
+      attribute :account_number,   :string
+      attribute :swift_code,       :string
+      attribute :account_currency, :string
+
+      validates :account_number,   presence: true
+      validates :swift_code,       presence: true
+      validates :contact_name,     presence: true
+      validates :account_currency, presence: true
+
+      def set_attributes(attrs = {})
+        self.account_number   = attrs.fetch("routing_info", {})["account_number"]
+        self.swift_code       = attrs.fetch("routing_info", {})["swift_code"]
+        self.account_currency = attrs.fetch("routing_info", {})["account_currency"]
+        super(attrs.except("routing_type", "routing_info"))
+      end
+
+      def as_json_routing_type
+        "SWIFT"
+      end
+
+      def as_json_routing_info
+        {
+          account_number:   account_number,
+          swift_code:       swift_code,
+          account_currency: account_currency
+        }
+      end
+    end
+  end
+end

data/lib/fidor_api/beneficiary/unknown.rb

@@ -0,0 +1,16 @@
+module FidorApi
+  module Beneficiary
+    class Unknown < Base
+      include Generic
+
+      attribute :routing_type, :string
+      attribute :routing_info, :json
+
+      def set_attributes(attrs = {})
+        self.routing_type = attrs["routing_type"]
+        self.routing_info = attrs["routing_info"]
+        super(attrs.except("routing_type", "routing_info"))
+      end
+    end
+  end
+end

data/lib/fidor_api/beneficiary/utility.rb

@@ -0,0 +1,35 @@
+module FidorApi
+  module Beneficiary
+    class Utility < Base
+      include Generic
+
+      attribute :utility_provider,        :string
+      attribute :utility_service,         :string
+      attribute :utility_service_number,  :string
+
+      validates :utility_provider,        presence: true
+      validates :utility_service,         presence: true
+      validates :utility_service_number,  presence: true
+      validates :unique_name,             presence: true
+
+      def set_attributes(attrs = {})
+        self.utility_provider        = attrs.fetch("routing_info", {})["utility_provider"]
+        self.utility_service         = attrs.fetch("routing_info", {})["utility_service"]
+        self.utility_service_number  = attrs.fetch("routing_info", {})["utility_service_number"]
+        super(attrs.except("routing_type", "routing_info"))
+      end
+
+      def as_json_routing_type
+        "UTILITY"
+      end
+
+      def as_json_routing_info
+        {
+          utility_provider:        utility_provider,
+          utility_service:         utility_service,
+          utility_service_number:  utility_service_number
+        }
+      end
+    end
+  end
+end

data/lib/fidor_api/beneficiary.rb

@@ -0,0 +1,27 @@
+module FidorApi
+  module Beneficiary
+    autoload :Base,             'fidor_api/beneficiary/base'
+    autoload :Generic,          'fidor_api/beneficiary/generic'
+    autoload :ACH,              'fidor_api/beneficiary/ach'
+    autoload :P2pAccountNumber, 'fidor_api/beneficiary/p2p_account_number'
+    autoload :P2pPhone,         'fidor_api/beneficiary/p2p_phone'
+    autoload :P2pUsername,      'fidor_api/beneficiary/p2p_username'
+    autoload :Swift,            'fidor_api/beneficiary/swift'
+    autoload :Unknown,          'fidor_api/beneficiary/unknown'
+    autoload :Utility,          'fidor_api/beneficiary/utility'
+
+    module ClientSupport
+      def beneficiaries(options = {})
+        Beneficiary::Base.all(options)
+      end
+
+      def beneficiary(id)
+        Beneficiary::Base.find(id)
+      end
+
+      def delete_beneficiary(id)
+        Beneficiary::Base.delete(id)
+      end
+    end
+  end
+end