bigbank-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dca78c7ee8f28b592bbfd1afe2d225c265f7632
+  data.tar.gz: ae47f9bba3f308c271fae455d2d6fbba7ff7ad8b
+SHA512:
+  metadata.gz: 867d2ef4fbf35380c295b97480f71e7a5a6b0358928ce8d401c8d4f7e47fdd639e1d2a3f9e4d4947c3a0599c2152c150c835d02f321d7c63176861a7fb567a8b
+  data.tar.gz: 56081db7547c14452c2bb76c4d31f28f9a3c189a6fcd4b98d5587d7311843d06e20bdc81c362844d472ced433d1456299cf58b89277df6d49605137945fd4e00

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at martin@digitalkookie.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Martin Samami
+
+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,100 @@
+# Bigbank Ruby Client
+[![CircleCI](https://circleci.com/gh/MrTin/bigbank-client.svg?style=svg)](https://circleci.com/gh/MrTin/bigbank-client)
+
+## Installation
+Add it to your Gemfile:
+```ruby
+gem 'bigbank-client'
+```
+
+## Bigbank requirements
+- You need to send them an `IP or IP Range` for them to whitelist requests from
+your servers.
+- Request a `partner key` to authorize your requests.
+
+## Configuration
+**Rails:** put this inside an initializer at e.g.
+`config/initializers/bigbank_client.rb`
+```ruby
+# Available endpoints:
+# - Estonia: https://www.bigbank.ee/
+# - Latvia: https://www.bigbank.lv/
+# - Lithuania: https://www.bigbank.lt/
+# - Finland: https://www.bigbank.fi/
+# - Sweden: https://www.bigbank.se/
+# - Spain: https://www.bigbank.es/
+
+Bigbank::Client.configure do |config|
+  config.endpoint = "https://ansok.bigbank.se/"
+  config.partner_key = "super-secret-partner-key"
+  # config.adapter = Faraday.default_adapter
+  # config.verify_ssl = true
+  # config.enable_proxy = false
+  # config.proxy = "https://username:password@proxy.example.com/"
+end
+```
+
+## Usage
+Endpoint requests will return a `Bigbank::Client::Result` which you can work
+with as if it was an Enumerable.
+
+All but the following methods on a will be passed on to the resulting body:
+- `#success?`
+- `#errors?`
+- `#response` access the underlying request object (see [lostisland/faraday](https://github.com/lostisland/faraday) for more info).
+
+### Example result
+```ruby
+fields = Bigbank::Client::Fields.all
+#=> <Bigbank::Client::Result:0x007fc7698a3b48>
+
+fields.each { |field| puts field }
+```
+
+## Supported endpoints
+### Fields
+Retrieve all fields to build a loan application form.
+```ruby
+fields = Bigbank::Client::Fields.all
+# => <Bigbank::Client::Result:0x007fc7698a3b48>
+
+fields.each { |field| puts field }
+```
+
+### Application
+Create a loan application.
+```ruby
+response = Bigbank::Client::Application.create({
+    ...
+  })
+# => #<Bigbank::Client::Result:0x007fc7698a3b48>
+
+```
+
+## Using a proxy
+If you are running into SSL issue while making `https://` requests you are
+advised to set `verify_ssl = false`. Just don't do this in production unless
+you really need it e.g. to use a proxy, as this opens up a potential attack
+vector in your software.
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/mrtin/bigbank-client. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bigbank-client.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bigbank/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bigbank-client"
+  spec.version       = Bigbank::Client::VERSION
+  spec.authors       = ["Martin Samami"]
+  spec.email         = ["martin@digitalkookie.io"]
+
+  spec.summary       = %q{A Ruby client for the Bigbank API to request and create loan applications.}
+  spec.homepage      = "https://github.com/mrtin/bigbank-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "json"
+end

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bigbank/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.4.1

data/lib/bigbank/client/config.rb

@@ -0,0 +1,28 @@
+module Bigbank
+  module Client
+    class Config
+      attr_accessor :endpoint,
+                    :partner_key,
+                    :open_timeout,
+                    :timeout,
+                    :adapter,
+                    :verify_ssl,
+                    :enable_proxy,
+                    :proxy
+
+      def initialize
+        @endpoint = "https://ansok.bigbank.se/"
+        @open_timeout = 5
+        @timeout = 15
+        @adapter = Faraday.default_adapter
+        @verify_ssl = true
+        @enable_proxy = false
+        @proxy = ""
+      end
+
+      def enable_proxy?
+        !!enable_proxy
+      end
+    end
+  end
+end

data/lib/bigbank/client/endpoint.rb

@@ -0,0 +1,27 @@
+module Bigbank
+  module Client
+    class Endpoint
+      def connection
+        @connection ||=
+          ::Faraday.new(url: config.endpoint) do |builder|
+            builder.use ::Faraday::Request::UrlEncoded
+            builder.response :json, :content_type => /\bjson$/
+            builder.headers["User-Agent"] = user_agent
+            builder.options[:open_timeout] = config.open_timeout
+            builder.options[:timeout] = config.timeout
+            builder.adapter config.adapter
+            builder.ssl.verify = config.verify_ssl
+            builder.proxy(config.proxy) if config.enable_proxy?
+          end
+      end
+
+      def config
+        Bigbank::Client.config
+      end
+
+      def user_agent
+        "bigbank-client v#{::Bigbank::Client::VERSION} (github.com/mrtin/bigbank-client)"
+      end
+    end
+  end
+end

data/lib/bigbank/client/endpoints/application.rb

@@ -0,0 +1,25 @@
+module Bigbank
+  module Client
+    class Application < Endpoint
+      attr_accessor :post_params
+
+      def self.create(*args)
+        self.new(*args).create
+      end
+
+      def initialize(post_params={})
+        @post_params = post_params
+      end
+
+      def create
+        response = connection.post do |request|
+          request.url "/api/"
+          request.params = { post: "data" }
+          request.body = { key: config.partner_key }.merge!(post_params)
+        end
+
+        Result.new(response)
+      end
+    end
+  end
+end

data/lib/bigbank/client/endpoints/field.rb

@@ -0,0 +1,18 @@
+module Bigbank
+  module Client
+    class Field < Endpoint
+      def self.all
+        self.new.all
+      end
+
+      def all
+        response = connection.get do |request|
+          request.url "/api/"
+          request.params = { get: "values", key: config.partner_key }
+        end
+
+        Result.new(response)
+      end
+    end
+  end
+end

data/lib/bigbank/client/error.rb

@@ -0,0 +1,5 @@
+module Bigbank
+  module Client
+    Error = Class.new(StandardError)
+  end
+end

data/lib/bigbank/client/result.rb

@@ -0,0 +1,31 @@
+module Bigbank
+  module Client
+    class Result
+      attr_accessor :response
+
+      def initialize(response)
+        @response = response
+      end
+
+      # Public: result is a success
+      #
+      # return @boolean
+      def success?
+        response.status == 200
+      end
+
+      # Public: result is a failure
+      #
+      # return @boolean
+      def errors?
+        !success?
+      end
+
+      # Allows us to work directly with the result in a more natural way e.g.
+      # use enumerator methods, nil check etc.
+      def method_missing(name, *args, &block)
+        response.body.send(name, *args, &block)
+      end
+    end
+  end
+end

data/lib/bigbank/client/testing.rb

@@ -0,0 +1,15 @@
+module Bigbank
+  module Client
+    # TODO: methods to stub/mock
+
+
+    # Bigbank::Client.enable_testing!
+    # Bigbank::Client.disable_testing!
+
+    # Bigbank::Client::Field.all
+    # => {} <Bigbank::Client::Response> (FakeResponse < Response?)
+
+    # Bigbank::Client::Application.create({})
+    # => {} <Bigbank::Client::Response>
+  end
+end

data/lib/bigbank/client/version.rb

@@ -0,0 +1,5 @@
+module Bigbank
+  module Client
+    VERSION = "0.1.0"
+  end
+end

data/lib/bigbank/client.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require_relative "client/version"
+require_relative "client/error"
+require_relative "client/config"
+require_relative "client/endpoint"
+require_relative "client/result"
+
+require_relative "client/endpoints/field"
+require_relative "client/endpoints/application"
+
+module Bigbank
+  module Client
+    class << self
+      attr_accessor :config
+    end
+
+    def self.configure
+      self.config ||= Bigbank::Client::Config.new
+      yield(config)
+    end
+  end
+end
+
+Bigbank::Client.configure {}

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: bigbank-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Samami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- martin@digitalkookie.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bigbank-client.gemspec
+- bin/console
+- bin/setup
+- circle.yml
+- lib/bigbank/client.rb
+- lib/bigbank/client/config.rb
+- lib/bigbank/client/endpoint.rb
+- lib/bigbank/client/endpoints/application.rb
+- lib/bigbank/client/endpoints/field.rb
+- lib/bigbank/client/error.rb
+- lib/bigbank/client/result.rb
+- lib/bigbank/client/testing.rb
+- lib/bigbank/client/version.rb
+homepage: https://github.com/mrtin/bigbank-client
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A Ruby client for the Bigbank API to request and create loan applications.
+test_files: []