atrium-ruby 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a2f54ad9be7cba045db2d902ce3e3e4c071f917
-  data.tar.gz: 191b3c86c948477d2d82cff9c66258e1348991ef
+  metadata.gz: 245392ec9efa63cc44d3d292397c47a32a03a16b
+  data.tar.gz: 4a07efc49acf876f734942c70b9f2e0fb6cd62d5
 SHA512:
-  metadata.gz: d295f5e1379ad37a4992b11d79f048299ad90557cd47a6363806aca3bedb131e95616cfcc82c8e5dac0df17cb940f813ccad52af25a9d59b85a534a89ec0240d
-  data.tar.gz: 3cca73816865d03d5e2347b485dbf98264fb441e176ae258492249ece3cba8e0c6ddbf1cc9f8f75838e19019cb5446f4e094ce8bcccc994d4dc0c0d65e0960ca
+  metadata.gz: a3a18069855ba1a1b7b5076d5428fc856729b1a90a47ac9eab4478ef248922683193317ddce8956602895adb466e4912500dcbd8e02a4fce25ab639fab73fea1
+  data.tar.gz: 3073ba5011c23cf91cd44041d660cf258a29ccb2857f677e57841cd880d7cc01e0fee1896db94b689807fc2a18b86640d263626e58cb438c724d0c7bfbd8d1a4

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# inherit_from: .rubocop_todo.yml
+inherit_gem:
+  mad_rubocop: .rubocop.yml
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - 'Gemfile'
+    - 'Rakefile'
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -1,9 +1,11 @@
 language: ruby
+rvm:
+ - 2.4
+ - 2.3
 sudo: false
 cache: bundler
-branches:
-  only:
-  - master
+before_script:
+  - bundle exec rubocop
 notifications:
   email:
     on_success: never

data/Gemfile

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

data/README.md

@@ -1,4 +1,4 @@
-# Atrium-Ruby
+# Atrium-Ruby [![Build Status](https://travis-ci.org/mxenabled/atrium-ruby.svg?branch=master)](https://travis-ci.org/mxenabled/atrium-ruby)
 
 A Ruby wrapper for use with the [MX Atrium API](https://atrium.mx.com). In order to make requests, you will need to [sign up for MX Atrium API](https://atrium.mx.com/developers/sign_up) and get a `MX-API-KEY` and `MX-CLIENT-ID`. Then, configure your instance with:
 ```ruby

data/atrium-ruby.gemspec

@@ -1,7 +1,8 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'atrium/version'
+require "atrium/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "atrium-ruby"
@@ -25,4 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "mad_rubocop"
 end

data/bin/demo

@@ -5,9 +5,9 @@ require "pry"
 require "yaml"
 
 def load_settings
-  if ::File.exists?("tmp/settings.yml")
+  if ::File.exist?("tmp/settings.yml")
     puts "=> Using key and ID in tmp/settings.yml ¬"
-    ::YAML.load(::File.read("tmp/settings.yml"))
+    ::YAML.safe_load(::File.read("tmp/settings.yml"))
   else
     settings = {}
     puts "What is your MX-API-KEY?"
@@ -27,11 +27,10 @@ def load_settings
       settings
     end
   end
-
 end
 
 settings = load_settings
-settings.each { |k,v| puts "\t#{k}: #{v}" }
+settings.each { |k, v| puts "\t#{k}: #{v}" }
 
 ::Atrium.configure do |config|
   config.mx_client_id = settings[:mx_client_id]

data/lib/atrium.rb

@@ -5,6 +5,7 @@ require "atrium/paginate"
 
 require "atrium/account"
 require "atrium/client"
+require "atrium/connect"
 require "atrium/credential"
 require "atrium/error"
 require "atrium/institution"

data/lib/atrium/account.rb

@@ -36,7 +36,7 @@ module Atrium
       endpoint = "/users/#{user_guid}/accounts"
       accounts_response = ::Atrium.client.make_request(:get, endpoint)
 
-      accounts = accounts_response["accounts"].map do |account|
+      accounts_response["accounts"].map do |account|
         ::Atrium::Account.new(account)
       end
     end
@@ -50,10 +50,10 @@ module Atrium
     end
 
     def transactions
-      endpoint = "/users/#{self.user_guid}/accounts/#{self.guid}/transactions"
+      endpoint = "/users/#{user_guid}/accounts/#{guid}/transactions"
       account_transactions_response = ::Atrium.client.make_request(:get, endpoint)
 
-      transactions = account_transactions_response["transactions"].map do |transaction|
+      account_transactions_response["transactions"].map do |transaction|
         ::Atrium::Transaction.new(transaction)
       end
     end

data/lib/atrium/client.rb

@@ -1,18 +1,20 @@
 module Atrium
   class Client
+    DEVELOPMENT_URL = "https://vestibule.mx.com".freeze
     attr_accessor :mx_api_key, :mx_client_id, :base_url
 
-    def initialize(api_key = nil, client_id = nil, base_url = "https://vestibule.mx.com")
-      @mx_api_key = api_key
+    def initialize(api_key = nil, client_id = nil, base_url = DEVELOPMENT_URL)
+      @mx_api_key   = api_key
       @mx_client_id = client_id
-      @base_url = base_url
+      @base_url     = base_url
     end
 
-    def make_request(method, endpoint, body = {}, headers = {})
+    def make_request(method, endpoint, body = nil, headers = {})
       headers = default_headers.merge(headers)
-      url = "#{self.base_url}#{endpoint}"
+      url     = "#{base_url}#{endpoint}"
+      body    = ::JSON.dump(body) if body
 
-      response = http_client.public_send(method, url, ::JSON.dump(body), headers)
+      response = http_client.public_send(method, url, body, headers)
 
       handle_response(response)
     end
@@ -25,9 +27,9 @@ module Atrium
 
     def default_headers
       {
-        "Accept" => "application/vnd.mx.atrium.v1+json",
+        "Accept"       => "application/vnd.mx.atrium.v1+json",
         "Content-Type" => "application/json",
-        "MX-API-KEY" => mx_api_key,
+        "MX-API-KEY"   => mx_api_key,
         "MX-CLIENT-ID" => mx_client_id
       }
     end
@@ -35,7 +37,7 @@ module Atrium
     def handle_response(response)
       # Handle 200-206 responses as acceptable
       unless response.status.between?(200, 206)
-        fail ::Atrium::Error, "#{response.status}: #{response.body}"
+        raise ::Atrium::Error, "#{response.status}: #{response.body}"
       end
 
       ::JSON.parse(response.body) unless response.body.empty?

data/lib/atrium/connect.rb

@@ -0,0 +1,22 @@
+module Atrium
+  class Connect
+    include ::ActiveAttr::Model
+
+    SCRIPT_SOURCE = "https://atrium.mx.com/connect.js".freeze
+
+    # ATTRIBUTES
+    attribute :connect_widget_url
+    attribute :guid
+
+    ##
+    # CLASS METHODS
+    #
+    def self.create(user_guid:)
+      endpoint = "/users/#{user_guid}/connect_widget_url"
+      connect_response = ::Atrium.client.make_request(:post, endpoint)
+
+      connect_params = connect_response["user"]
+      ::Atrium::Connect.new(connect_params)
+    end
+  end
+end

data/lib/atrium/institution.rb

@@ -4,11 +4,12 @@ module Atrium
     include ::ActiveAttr::Model
 
     attribute :code
-    attribute :medium_logo_url
     attribute :name
-    attribute :small_logo_url
     attribute :url
+    attribute :small_logo_url
+    attribute :medium_logo_url
 
+    # @todo Normalize params interface across gem, most of gem favors hash
     def self.credentials(institution_code)
       endpoint = "/institutions/#{institution_code}/credentials"
       response = ::Atrium.client.make_request(:get, endpoint)
@@ -18,12 +19,20 @@ module Atrium
       end
     end
 
+    def self.read(institution_code:)
+      endpoint = "/institutions/#{institution_code}"
+      response = ::Atrium.client.make_request(:get, endpoint)
+
+      institution_params = response["institution"]
+      ::Atrium::Institution.new(institution_params)
+    end
+
     def self.list(query_params: nil, limit: nil)
-      paginate_endpoint(query_params: query_params, limit: limit)
+      paginate_endpoint(:query_params => query_params, :limit => limit)
     end
 
     def self.list_in_batches(query_params: nil, limit: nil, &block)
-      paginate_endpoint_in_batches(query_params: query_params, limit: limit, &block)
+      paginate_endpoint_in_batches(:query_params => query_params, :limit => limit, &block)
     end
   end
 end

data/lib/atrium/member.rb

@@ -13,7 +13,6 @@ module Atrium
     attribute :successfully_aggregated_at
     attribute :user_guid
 
-
     ##
     # CLASS METHODS
     #
@@ -47,7 +46,7 @@ module Atrium
     # INSTANCE METHODS
     #
     def accounts
-      endpoint = "/users/#{self.user_guid}/members/#{self.guid}/accounts"
+      endpoint = "/users/#{user_guid}/members/#{guid}/accounts"
       accounts_response = ::Atrium.client.make_request(:get, endpoint)
 
       accounts_response["accounts"].map do |account|
@@ -56,25 +55,25 @@ module Atrium
     end
 
     def aggregate
-      endpoint = "/users/#{self.user_guid}/members/#{self.guid}/aggregate"
+      endpoint = "/users/#{user_guid}/members/#{guid}/aggregate"
       member_response = ::Atrium.client.make_request(:post, endpoint)
 
       member_params = member_response["member"]
-      self.assign_attributes(member_params)
+      assign_attributes(member_params)
       self
     end
 
     def aggregation_status
-      endpoint = "/users/#{self.user_guid}/members/#{self.guid}/status"
+      endpoint = "/users/#{user_guid}/members/#{guid}/status"
       member_response = ::Atrium.client.make_request(:get, endpoint)
 
       member_params = member_response["member"]
-      self.assign_attributes(member_params)
+      assign_attributes(member_params)
       self
     end
 
     def challenges
-      endpoint = "/users/#{self.user_guid}/members/#{self.guid}/challenges"
+      endpoint = "/users/#{user_guid}/members/#{guid}/challenges"
       challenge_response = ::Atrium.client.make_request(:get, endpoint)
 
       return nil if challenge_response.nil?
@@ -87,14 +86,14 @@ module Atrium
     end
 
     def delete
-      endpoint = "/users/#{self.user_guid}/members/#{self.guid}"
+      endpoint = "/users/#{user_guid}/members/#{guid}"
       ::Atrium.client.make_request(:delete, endpoint)
 
       self
     end
 
     def read_account(account_guid:)
-      endpoint = "/users/#{self.user_guid}/members/#{self.guid}/accounts/#{account_guid}"
+      endpoint = "/users/#{user_guid}/members/#{guid}/accounts/#{account_guid}"
       account_response = ::Atrium.client.make_request(:get, endpoint)
 
       account_params = account_response["account"]
@@ -102,27 +101,27 @@ module Atrium
     end
 
     def resume(challenge_credentials)
-      endpoint = "/users/#{self.user_guid}/members/#{self.guid}/resume"
+      endpoint = "/users/#{user_guid}/members/#{guid}/resume"
       body = resume_params(challenge_credentials)
       member_response = ::Atrium.client.make_request(:put, endpoint, body)
 
       member_params = member_response["member"]
-      self.assign_attributes(member_params)
+      assign_attributes(member_params)
       self
     end
 
     def update(params)
-      endpoint = "/users/#{self.user_guid}/members/#{self.guid}"
+      endpoint = "/users/#{user_guid}/members/#{guid}"
       body = member_body(params)
       member_response = ::Atrium.client.make_request(:put, endpoint, body)
 
       member_params = member_response["member"]
-      self.assign_attributes(member_params)
+      assign_attributes(member_params)
       self
     end
 
     def transactions
-      endpoint = "/users/#{self.user_guid}/members/#{self.guid}/transactions"
+      endpoint = "/users/#{user_guid}/members/#{guid}/transactions"
       transactions_response = ::Atrium.client.make_request(:get, endpoint)
 
       transactions_response["transactions"].map do |transaction|
@@ -141,20 +140,9 @@ module Atrium
         }
       }
     end
+    private_class_method :create_params
 
-    def self.member_body(params)
-      {
-        :member => {
-          :credentials => params[:credentials],
-          :identifier => params[:identifier],
-          :institution_code => params[:institution_code],
-          :metadata => params[:metadata]
-        }
-      }
-    end
-    private_class_method :create_params, :member_body
-
-    private
+  private
 
     ##
     # PRIVATE INSTANCE METHODS

data/lib/atrium/paginate.rb

@@ -9,12 +9,13 @@ module Atrium
 
     def endpoint_name(query_params: nil)
       @endpoint = if query_params.present?
-        "/" + klass_name + "?" + URI.encode_www_form(query_params) + "&"
-      else
-        "/" + klass_name + "?"
-      end
+                    "/" + klass_name + "?" + URI.encode_www_form(query_params) + "&"
+                  else
+                    "/" + klass_name + "?"
+                  end
     end
 
+    # rubocop:disable Style/AccessorMethodName
     def get_total_pages
       @current_page = INITIAL_PAGE
 
@@ -24,23 +25,24 @@ module Atrium
       pagination = response["pagination"]
       @total_pages  = pagination["total_pages"]
     end
+    # rubocop:enable Style/AccessorMethodName
 
     def klass_name
-      @klass_name ||= self.name.gsub("Atrium::", "").downcase.pluralize
+      @klass_name ||= name.gsub("Atrium::", "").downcase.pluralize
     end
 
     def paginate_endpoint(query_params: nil, limit: nil)
-      endpoint_name(query_params: query_params)
+      endpoint_name(:query_params => query_params)
       get_total_pages
-      response_list(limit: limit)
+      response_list(:limit => limit)
     end
 
     def paginate_endpoint_in_batches(query_params: nil, limit: nil, &block)
       return "method requires block to be passed" unless block_given?
 
-      endpoint_name(query_params: query_params)
+      endpoint_name(:query_params => query_params)
       get_total_pages
-      response_list_in_batches(limit: limit, &block)
+      response_list_in_batches(:limit => limit, &block)
     end
 
     def records_per_page
@@ -53,12 +55,12 @@ module Atrium
       list = []
 
       until current_page > total_pages
-        paginated_endpoint =  endpoint + "page=#{current_page}&records_per_page=#{records_per_page}"
+        paginated_endpoint = endpoint + "page=#{current_page}&records_per_page=#{records_per_page}"
         response = ::Atrium.client.make_request(:get, paginated_endpoint)
 
         # Add new objects to the list
-        response["#{klass_name}"].each do |params|
-          list << self.new(params)
+        response[klass_name.to_s].each do |params|
+          list << new(params)
         end
         @current_page += 1
       end
@@ -70,17 +72,17 @@ module Atrium
       end
     end
 
-    def response_list_in_batches(limit: nil, &block)
+    def response_list_in_batches(limit: nil)
       # "total_pages > 1" check exists since some query_params only return 1 page
       @total_pages = limit / records_per_page if limit.present? && total_pages > 1
 
       until current_page > total_pages
-        paginated_endpoint =  endpoint + "page=#{current_page}&records_per_page=#{records_per_page}"
+        paginated_endpoint = endpoint + "page=#{current_page}&records_per_page=#{records_per_page}"
         response = ::Atrium.client.make_request(:get, paginated_endpoint)
         list = []
 
-        response["#{klass_name}"].each do |params|
-          list << self.new(params)
+        response[klass_name.to_s].each do |params|
+          list << new(params)
         end
         @current_page += 1
         yield list

data/lib/atrium/user.rb

@@ -41,7 +41,7 @@ module Atrium
     # INSTANCE METHODS
     #
     def accounts
-      endpoint = "/users/#{self.guid}/accounts"
+      endpoint = "/users/#{guid}/accounts"
       response = ::Atrium.client.make_request(:get, endpoint)
 
       response["accounts"].map do |account|
@@ -50,14 +50,14 @@ module Atrium
     end
 
     def delete
-      endpoint = "/users/#{self.guid}"
+      endpoint = "/users/#{guid}"
       ::Atrium.client.make_request(:delete, endpoint)
 
       self
     end
 
     def members
-      endpoint = "/users/#{self.guid}/members"
+      endpoint = "/users/#{guid}/members"
       response = ::Atrium.client.make_request(:get, endpoint)
 
       response["members"].map do |member|
@@ -66,7 +66,7 @@ module Atrium
     end
 
     def transactions
-      endpoint = "/users/#{self.guid}/transactions"
+      endpoint = "/users/#{guid}/transactions"
       response = ::Atrium.client.make_request(:get, endpoint)
 
       response["transactions"].map do |transaction|
@@ -75,16 +75,16 @@ module Atrium
     end
 
     def update(params)
-      endpoint = "/users/#{self.guid}"
+      endpoint = "/users/#{guid}"
       body = update_params(params)
       response = ::Atrium.client.make_request(:put, endpoint, body)
 
       user_params = response["user"]
-      self.assign_attributes(user_params)
+      assign_attributes(user_params)
       self
     end
 
-    private
+  private
 
     def update_params(params)
       {
@@ -101,5 +101,6 @@ module Atrium
         }
       }
     end
+    private_class_method :user_body
   end
 end

data/lib/atrium/version.rb

@@ -1,3 +1,3 @@
 module Atrium
-  VERSION = "0.4.3"
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atrium-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Jon Carstens, Dan Jones, Zach Toolson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
@@ -94,6 +94,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: mad_rubocop
+  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'
 description: Ruby wrapper for the Atrium API by MX
 email:
 - jon.carstens@mx.com, dan.jones@mx.com, zach.toolson@mx.com
@@ -102,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -114,6 +171,7 @@ files:
 - lib/atrium/account.rb
 - lib/atrium/challenge.rb
 - lib/atrium/client.rb
+- lib/atrium/connect.rb
 - lib/atrium/credential.rb
 - lib/atrium/error.rb
 - lib/atrium/institution.rb