fund_america 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 136d970c9bce8151a127ce98ab90f8a6e2952009
-  data.tar.gz: 59427c4157ebc98a365294f0ccd83c5ace8f54ab
+  metadata.gz: c6acc1a01eebae1c79f7532d2fd0cab848d22686
+  data.tar.gz: 88e45bd272f2cfd3473283a82e4f38bd946b2712
 SHA512:
-  metadata.gz: 93266a647c58cfe28d31d372bd2fd05b4f2a3f2f706355b6f55e543708e78b0dc68a4c423e00d9d2f01ac458c879311dc03170b35b2c3035a71fa3537f9861a4
-  data.tar.gz: 8b69f0eecae5db59295b2fedfddd718390d282fbaf3a58daaa93b1b3f7a794b1c6c4b1bb0297e58215e446b966cfab7e5035ade4fd80b9c87c927c44a0077b5e
+  metadata.gz: d852871d977ee7de39016b31f3a54df4df0b2c82dbb62d76c7979f0cef7cad1cc206cf52dbd2e9daad6391ed67efd196f92accef349265c8c421c488fa737810
+  data.tar.gz: fa9c23ca914d415316c423a3a46be2dbd49c1e24e63b8f125e995c1251021a0d7d0bc161a116ef9725dec12ab80c26111ae90b37057136d90c033c9287824b80

data/README.md

@@ -20,19 +20,19 @@ Or install it yourself as:
 
 ## Usage
 
-The details on usage of FundAmerica gem are present at: http://www.rubyeffect.com/blog/category/fundamerica/. If you wish to see FundAmerica's API documentation, please visit the url: https://apps.fundamerica.com/support/documentation
-
-1. [FundAmerica Gem Introductory Post](http://www.rubyeffect.com/blog/fundamerica-gem/)
-2. [Entity Endpoints Part One](http://www.rubyeffect.com/blog/fundamerica-gem-entity-endpoints/)
-3. [Entity Endpoints Part Two](http://www.rubyeffect.com/blog/fundamerica-gem-entity-endpoints-part-two/)
-4. [API Info](http://www.rubyeffect.com/blog/fundamerica-gem-api-info-ach-authorizations/)
-5. [ACH Authorizations](http://www.rubyeffect.com/blog/fundamerica-gem-api-info-ach-authorizations/)
-6. [Background Checks](http://www.rubyeffect.com/blog/fundamerica-gem-background-checks-bank-info/)
-7. [Bank Info](http://www.rubyeffect.com/blog/fundamerica-gem-background-checks-bank-info/)
-8. [Error Handling](http://www.rubyeffect.com/blog/fundamerica-gem-error-handling/)
-9. [Offerings](http://www.rubyeffect.com/blog/fundamerica-gem-offerings/)
-10. [Cancel Offering Request](http://www.rubyeffect.com/blog/fundamerica-gem-cancel-close-offering-requests/)
-11. [Close Offering Request](http://www.rubyeffect.com/blog/fundamerica-gem-cancel-close-offering-requests/)
+The details on usage of FundAmerica gem are present at: http://blog.rubyeffect.com/category/fundamerica/. If you wish to see FundAmerica's API documentation, please visit the url: https://apps.fundamerica.com/support/documentation
+
+1. [FundAmerica Gem Introductory Post](http://blog.rubyeffect.com/fundamerica-gem/)
+2. [Entity Endpoints Part One](http://blog.rubyeffect.com/fundamerica-gem-entity-endpoints/)
+3. [Entity Endpoints Part Two](http://blog.rubyeffect.com/fundamerica-gem-entity-endpoints-part-two/)
+4. [API Info](http://blog.rubyeffect.com/fundamerica-gem-api-info-ach-authorizations/)
+5. [ACH Authorizations](http://blog.rubyeffect.com/fundamerica-gem-api-info-ach-authorizations/)
+6. [Background Checks](http://blog.rubyeffect.com/fundamerica-gem-background-checks-bank-info/)
+7. [Bank Info](http://blog.rubyeffect.com/fundamerica-gem-background-checks-bank-info/)
+8. [Error Handling](http://blog.rubyeffect.com/fundamerica-gem-error-handling/)
+9. [Offerings](http://blog.rubyeffect.com/fundamerica-gem-offerings/)
+10. [Cancel Offering Request](http://blog.rubyeffect.com/fundamerica-gem-cancel-close-offering-requests/)
+11. [Close Offering Request](http://blog.rubyeffect.com/fundamerica-gem-cancel-close-offering-requests/)
 
 ## TODO
 
@@ -45,7 +45,15 @@ The details on usage of FundAmerica gem are present at: http://www.rubyeffect.co
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Running tests
+
+To the run tests get a sandbox key from `https://sandbox.fundamerica.com/accounts/<your-account>/api_keys` then run:
+
+```console
+$ env FUND_AMERICA_SANDBOX_KEY='<YOUR-SANDBOX-KEY>' rspec
+```
 
 ## Contributing
 
@@ -59,13 +67,14 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 1. Dan M (https://github.com/dan987)
 2. Charles S (https://github.com/Designbookcom)
+3. David Reid (https://github.com/dreid)
 
 ## About RubyEffect
 
-![RubyEffect](http://www.rubyeffect.com/blog/wp-content/uploads/2015/05/cropped-re_original_logo.png)
+![RubyEffect](http://blog.rubyeffect.com/wp-content/uploads/2015/05/cropped-re_original_logo.png)
 
 RubyEffect builds intuitive, live and elegant software that solves real world problems. We love open source and it's community.
 
-Liked this gem? You may also like the articles we post on our [blog](http://www.rubyeffect.com/blog). Please do check
+Liked this gem? You may also like the articles we post on our [blog](http://blog.rubyeffect.com). Please do check
 
 We would love to work on your ideas and see them grow. Say hello @ http://rubyeffect.com/contact

data/fund_america.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Ruby gem for easy implementation of FundAmerica API in ruby, rails, sinatra apps}
   spec.description   = %q{This is a ruby gem to use the FundAmerica (http://www.fundamerica.com) API easily in your ruby, rails and sinatra apps built by RubyEffect (http://www.rubyeffect.com)}
-  spec.homepage      = "http://www.rubyeffect.com/blog/category/fundamerica"
+  spec.homepage      = "http://blog.rubyeffect.com/category/fundamerica/"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or

data/lib/fund_america.rb

@@ -6,11 +6,7 @@ module FundAmerica
   class << self
     # Returns API key or raises exception
     def api_key
-      # TODO - Uncomment below line for production
       defined? @api_key and @api_key or raise "FundAmerica.api_key not configured"
-
-      # Sandbox test API key is used for development
-      # defined? @api_key and @api_key or @api_key = test_api_key
     end
     attr_writer :api_key
 
@@ -45,11 +41,5 @@ module FundAmerica
         }
       }
     end
-
-    # Sandbox API key - Only for development purpose
-    # TODO - Remove this method for production
-    # def test_api_key
-    #  "sandbox-key-here"
-    # end
   end
 end

data/lib/fund_america/all.rb

@@ -9,11 +9,13 @@ require 'fund_america/error'
 # API end points below
 require 'fund_america/api_info'
 require 'fund_america/ach_authorization'
+require 'fund_america/aml_exception'
 require 'fund_america/background_check'
 require 'fund_america/bank_info'
 require 'fund_america/billing_log'
 require 'fund_america/cancel_offering_request'
 require 'fund_america/close_offering_request'
+require 'fund_america/customer_agreement'
 require 'fund_america/electronic_signature'
 require 'fund_america/entity_relationship'
 require 'fund_america/entity'

data/lib/fund_america/aml_exception.rb

@@ -0,0 +1,29 @@
+module FundAmerica
+  class AmlException
+    class << self
+
+      # End point: https://apps.fundamerica.com/api/aml_exceptions (GET)
+      # Usage: FundAmerica::AmlException.list
+      # Output: Returns list of aml_exceptions
+      def list
+        API::request(:get, FundAmerica.base_uri + 'aml_exceptions')
+      end
+
+      # End point: https://apps.fundamerica.com/api/aml_exceptions/:id (GET)
+      # Usage: FundAmerica::AmlException.details(aml_exception_id)
+      # Output: Returns the details of an aml_exception with matching id
+      def details(aml_exception_id)
+        API::request(:get, FundAmerica.base_uri + "aml_exceptions/#{aml_exception_id}")
+      end
+
+      # End point: https://sandbox.fundamerica.com/api/test_mode/aml_exceptions/:id (PATCH)
+      # Usage: FundAmerica::AmlException.update(aml_exception_id)
+      # Output: Updates an aml exception in test mode
+      # Important: This works only for Sandbox mode
+      def update(aml_exception_id, options)
+        API::request(:patch, FundAmerica.base_uri + "test_mode/aml_exceptions/#{aml_exception_id}", options)
+      end
+
+    end
+  end
+end

data/lib/fund_america/customer_agreement.rb

@@ -0,0 +1,21 @@
+module FundAmerica
+  class CustomerAgreement
+    class << self
+
+      # End point: https://apps.fundamerica.com/api/entities/:id/customer_agreement/edit (GET)
+      # Usage: FundAmerica::CustomerAgreement.edit(entity_id)
+      # Output: Returns the form details for the customer agreement
+      def edit(entity_id)
+        API::request(:get, "entities/#{entity_id}/customer_agreement/edit")
+      end
+
+      # End point: https://apps.fundamerica.com/api/entities/:id/customer_agreement (PATCH)
+      # Usage: FundAmerica::CustomerAgreement.update(entity_id, options)
+      # Output: Fill out the customer agreement
+      def update(entity_id, options)
+        API::request(:patch, "entities/#{entity_id}/customer_agreement", options)
+      end
+
+    end
+  end
+end

data/lib/fund_america/distribution.rb

@@ -23,6 +23,13 @@ module FundAmerica
       	API::request(:get, "distributions/#{distribution_id}/investor_payments?page=#{page}&per=#{per}")
       end
 
+      # End point: https://apps/fundamerica.com/api/distributions/:id/non_investor_payments
+      # Usage: FundAmerica::Distribution.non_investor_payments(distribution_id)
+      # Output: Returns the non_investor_payments associated with distribution
+      def non_investor_payments(distribution_id, page, per)
+        API::request(:get, "distributions/#{distribution_id}/non_investor_payments?page=#{page}&per=#{per}")
+      end
+
     end
   end
 end

data/lib/fund_america/entity.rb

@@ -119,6 +119,14 @@ module FundAmerica
         API::request(:get, "entities/#{entity_id}/investor_accreditation")
       end
 
+      # https://apps.fundamerica.com/api/entities/:id/platform_investor (GET)
+      # Usage: FundAmerica::Entity.platform_investor 
+      # Output: Returns entity specific platform_investor information
+      # Note: FA platform investor information will also be included with investor information
+      def platform_investor(entity_id )
+        API::request(:get, "entities/#{entity_id}/platform_investor")
+      end
+
     end
   end
 end

data/lib/fund_america/error.rb

@@ -5,12 +5,12 @@ module FundAmerica
     # Contructor method to take response code and parsed_response
     # and give object methods in rescue - e.message and e.parsed_response
     def initialize(parsed_response, code)
-      super(FundAmerica::Error.error_message(code))
+      super(FundAmerica::Error.error_message(code, parsed_response))
       @parsed_response = parsed_response
     end
 
     # Method to return error message based on the response code
-    def self.error_message(code)
+    def self.error_message(code, parsed_response)
       case code
       when 401 then
         'Authentication error. Your API key is incorrect'
@@ -19,7 +19,7 @@ module FundAmerica
       when 404 then
         'Resource was not found'
       when 422 then
-        'This usually means you are missing or have supplied invalid parameters for a request'
+        "This usually means you are missing or have supplied invalid parameters for a request: #{parsed_response}"
       when 500 then
         "Internal server error. Something went wrong. This is a bug. Please report it to support immediately"
       else

data/lib/fund_america/version.rb

@@ -3,5 +3,5 @@ module FundAmerica
   # The format is Major dot Minor dot patch
   # Check the FundAmerica changelog regularly and add changes from it
   # Increase the patch number
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/fund_america/webhook_log.rb

@@ -2,11 +2,15 @@ module FundAmerica
   class WebhookLog
     class << self
 
-      # End point: https://apps.fundamerica.com/api/webhook_logs (GET)
+      # End point: https://apps.fundamerica.com/api/webhook_logs/?page=[num]&per=[num] (GET)
       # Usage: FundAmerica::WebhookLog.list
       # Output: Returns list of webhook_logs
-      def list
-        API::request(:get, 'webhook_logs')
+      # Params: (method defaults are the same as the current API defaults)
+      #  * page - page number of results; starts at 1, not 0
+      #  * per - number of results per page
+      def list(page: 1, per: 25)
+        request_uri = "webhook_logs/?page=#{page}&per=#{per}"
+        API::request(:get, request_uri)
       end
 
       # End point: https://apps.fundamerica.com/api/webhook_logs/:id (GET)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fund_america
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Sanjay Vedula
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-09 00:00:00.000000000 Z
+date: 2016-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ files:
 - lib/fund_america.rb
 - lib/fund_america/ach_authorization.rb
 - lib/fund_america/all.rb
+- lib/fund_america/aml_exception.rb
 - lib/fund_america/api.rb
 - lib/fund_america/api_info.rb
 - lib/fund_america/background_check.rb
@@ -123,6 +124,7 @@ files:
 - lib/fund_america/billing_log.rb
 - lib/fund_america/cancel_offering_request.rb
 - lib/fund_america/close_offering_request.rb
+- lib/fund_america/customer_agreement.rb
 - lib/fund_america/distribution.rb
 - lib/fund_america/electronic_signature.rb
 - lib/fund_america/email_log.rb
@@ -143,7 +145,7 @@ files:
 - lib/fund_america/trade_review.rb
 - lib/fund_america/version.rb
 - lib/fund_america/webhook_log.rb
-homepage: http://www.rubyeffect.com/blog/category/fundamerica
+homepage: http://blog.rubyeffect.com/category/fundamerica/
 licenses:
 - MIT
 metadata: {}
@@ -163,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby gem for easy implementation of FundAmerica API in ruby, rails, sinatra