plaid 10.1.0 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67b2fb1563bb0f5dc21d092bd5ae83e043f7cd1f48728dc47eb094325dbf340d
-  data.tar.gz: '09ed65928719206c075b22ccb8dbba5929b2c309bca6f329071dac1a24b4db29'
+  metadata.gz: a9657c1a46f6444a1cd4360595f92a007878401424702b967e3cf9a96c5337fe
+  data.tar.gz: b60e691103b431e9abc6bee0f9b93a9753216995fb0508f28f1ba7644833bc48
 SHA512:
-  metadata.gz: ede7755a232da3df4d8a464d77ccaa828ffba99e14d6677f0f85edcf21445475bf894a7dc7cbffccca38d9aed6fd3ee75f5591807460b05507213acc2c96cc8b
-  data.tar.gz: fc9cd109f8d7ee3fb75c323f10ea726e6cedd76000f260cbdce26b362e069eb1979cd3de853f5c6158e35f0e04546347620f0144a21e7331e0d90f4d1b7c4364
+  metadata.gz: 04fd20f7ee2e444d83571b1c11bc6c15472337087479d4d6b63a4b8f7ab99491de2d3600463234e758b2725fa76bb7fc6ca0ae7c7d1623cc5c07b44be78ee5b3
+  data.tar.gz: 66ceaf1ffbe114ca48bdc878dc3d4226e8d55aa1521ad3a49383e7908d2a40a54bfa213b3667daf6e7a31db4b962cab47c2d91e41cba045e5479ab7763c72733

data/.github/workflows/add_to_project.yml

@@ -0,0 +1,21 @@
+name: Auto Assign to CLIB Project
+
+on:
+  issues:
+    types: [opened]
+  pull_request:
+    types: [opened]
+env:
+  MY_GITHUB_TOKEN: ${{ secrets.CLIB_AUTOMATION_TOKEN }
+
+jobs:
+  assign_one_project:
+    runs-on: ubuntu-latest
+    name: Assign to One Project
+    steps:
+    - name: Assign NEW issues and NEW pull requests to project 1
+      uses: srggrs/assign-one-project-github-action@1.2.0
+      if: github.event.action == 'opened'
+      with:
+        project: 'https://github.com/orgs/plaid/projects/1'
+        column_name: 'Needs Investigation'

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 11.0.0
+
+- Add `merchant_name` to `Transaction`  (#294)
+
+BREAKING CHANGES:
+
+- Removes the public key as input to `Client`. The public key is no longer needed by the API. (#287)
+- Add link/token/create support  (#293)
+
 # 10.1.0
 
 - Add support for more options (`override_username`, `override_password`) in the `/sandbox/public_token/create` endpoint ([219](https://github.com/plaid/plaid-ruby/pull/219))

data/CONTRIBUTING.md

@@ -8,14 +8,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 The gem test suite can be run in two modes. By default, it runs against the
 live sandbox environment, creating items on the fly and calling various API
-endpoints for them. For this to work you'll need real `client_id`, `secret`,
-and `public_key` from your Plaid dashboard. Create a file named `.env`
-based on `.env.sample` which is provided:
+endpoints for them. For this to work you'll need real `client_id` and `secret`
+from your Plaid dashboard. Create a file named `.env` based on `.env.sample`
+which is provided:
 
 ```text
 PLAID_RUBY_CLIENT_ID=the_real_client_id
 PLAID_RUBY_SECRET=the_real_secret
-PLAID_RUBY_PUBLIC_KEY=the_real_public_key
 ```
 This file will be loaded during the tests.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (10.1.0)
+    plaid (11.0.0)
       faraday
       faraday_middleware
       hashie (>= 3.4.3)

data/PUBLISH.md

@@ -7,12 +7,13 @@ Prepare release:
 1. update `lib/plaid/version.rb`, and `CHANGELOG.md` files.
 2. run `bundle` to bump the version in `Gemfile.lock`
 3. create and merge a PR with the changes from 1 and 2.
+4. authenticate with rubygems with `gem signin` or manually set up your `~/.gem/credentials`
 
 Publish:
 
 1. `git checkout master` and `git pull` (makes sure your `HEAD` is up-to-date).
 2. Check that tests are passing on latest `master` build and (optional) `bundle exec rake test` to run tests locally
-3. `bundle exec rake release` (builds the gem, creates a tag, pushes the gem to RubyGems and tag to GitHub).
+3. `bundle exec rake release` (builds the gem, creates a tag, pushes the gem to RubyGems and tag to GitHub). **NOTE:** if this step hangs indefinitely, you need to set your MFA settings to "UI Only" [here](https://rubygems.org/profile/edit)
 4. `bundle exec rake update_github_docs` (generates RDoc files, updates `gh-pages` branch and pushes it to GitHub). (If you run into a `gh-pages` branch error, you may need to manually run `git checkout gh-pages` to ensure the branch is checked out locally.)
 
 [1]: https://rubygems.org/

data/README.md

@@ -41,15 +41,14 @@ The RubyDoc for the gem is available [here](http://plaid.github.io/plaid-ruby/).
 
 ### Creating a Plaid client
 
-Create an instance of the client using the `client_id`, `secret`, and `public_key` from your Plaid dashboard along with your environment of choice:
+Create an instance of the client using the `client_id` and `secret` from your Plaid dashboard along with your environment of choice:
 
 ```ruby
 require 'plaid'
 
 client = Plaid::Client.new(env: :sandbox,
                            client_id: '***',
-                           secret: '***',
-                           public_key: '***')
+                           secret: '***')
 ```
 
 The `env` field is the environment which the client will be running in. Your choices for the `env` field include:
@@ -63,7 +62,7 @@ The `env` field is the environment which the client will be running in. Your cho
 The gem uses Faraday to wrap HTTPS connections, which allows you to tune certain params:
 
 ```ruby
-client = Plaid::Client.new(env: :sandbox, client_id: '***', secret: '***', public_key: '***') do |builder|
+client = Plaid::Client.new(env: :sandbox, client_id: '***', secret: '***') do |builder|
   Plaid::Client.build_default_connection(builder)
 
   # Increase network timeout
@@ -91,8 +90,7 @@ require 'plaid'
 
 client = Plaid::Client.new(env: :sandbox,
                            client_id: '***',
-                           secret: '***',
-                           public_key: '***')
+                           secret: '***')
 
 exchange_token_response = client.item.public_token.exchange('[Plaid Link public_token]')
 access_token = exchange_token_response.access_token
@@ -107,8 +105,7 @@ require 'plaid'
 
 client = Plaid::Client.new(env: :sandbox,
                            client_id: '***',
-                           secret: '***',
-                           public_key: '***')
+                           secret: '***')
 
 exchange_token_response = client.item.public_token.exchange('[Plaid Link public_token]')
 access_token = exchange_token_response.access_token
@@ -136,8 +133,7 @@ require 'plaid'
 
 client = Plaid::Client.new(env: :sandbox,
                            client_id: '***',
-                           secret: '***',
-                           public_key: '***')
+                           secret: '***')
 
 exchange_token_response = client.item.public_token.exchange('[Plaid Link public_token]')
 access_token = exchange_token_response.access_token
@@ -154,8 +150,7 @@ require 'plaid'
 
 client = Plaid::Client.new(env: :sandbox,
                            client_id: '***',
-                           secret: '***',
-                           public_key: '***')
+                           secret: '***')
 
 exchange_token_response = client.item.public_token.exchange('[Plaid Link public_token]')
 access_token = exchange_token_response.access_token

data/Rakefile

@@ -54,7 +54,7 @@ end
 
 desc 'Hide real credentials in VCR cassettes'
 task :vcr_hide_credentials do
-  all_creds = %w[PLAID_RUBY_CLIENT_ID PLAID_RUBY_SECRET PLAID_RUBY_PUBLIC_KEY]
+  all_creds = %w[PLAID_RUBY_CLIENT_ID PLAID_RUBY_SECRET]
 
   all_creds.each do |cred|
     raise "#{cred} is not set" unless ENV[cred]

data/lib/plaid.rb

@@ -21,6 +21,7 @@ require_relative 'plaid/products/sandbox'
 require_relative 'plaid/products/transactions'
 require_relative 'plaid/products/investments'
 require_relative 'plaid/products/liabilities'
+require_relative 'plaid/products/link_token'
 require_relative 'plaid/products/payment_initiation'
 require_relative 'plaid/products/webhooks'
 require_relative 'plaid/client'

data/lib/plaid/client.rb

@@ -19,13 +19,11 @@ module Plaid
     # env        - The Symbol (:sandbox, :development, :production)
     # client_id  - The String Plaid account client ID to authenticate requests
     # secret     - The String Plaid account secret to authenticate requests
-    # public_key - The String Plaid account public key to authenticate requests
-    def initialize(env:, client_id:, secret:, public_key:, &block)
+    def initialize(env:, client_id:, secret:, &block)
       @env        = env.to_sym
       @api_host   = api_host
       @client_id  = client_id
       @secret     = secret
-      @public_key = public_key
 
       create_connection(&block)
     end
@@ -117,6 +115,11 @@ module Plaid
     # Public: The Plaid::Webhooks endpoint accessor.
     subproduct :webhooks
 
+    ##
+    ## :attr_reader:
+    ## Public: The Plaid::LinkToken endpoint accessor.
+    subproduct :link_token
+
     # Public: Make a post request
     #
     # path    - Path or URL to make the request to
@@ -140,16 +143,6 @@ module Plaid
       ).body
     end
 
-    # Public: Make a post request with appended public key field.
-    #
-    # path    - Path or URL to make the request to.
-    # payload - The payload or data to post.
-    #
-    # Returns the resulting parsed JSON of the request.
-    def post_with_public_key(path, payload)
-      @connection.post(path, payload.merge(public_key: @public_key)).body
-    end
-
     # Public: Set Plaid defaults on the Faraday connection.
     #
     # builder - The Faraday builder object.

data/lib/plaid/models.rb

@@ -976,6 +976,12 @@ module Plaid
       # Public: The location where transaction occurred (TransactionLocation).
       property :location, coerce: TransactionLocation
 
+      ##
+      # :attr_reader:
+      # Public: The String merchant name (or nil).
+      # E.g. "Burger King".
+      property :merchant_name
+
       ##
       # :attr_reader:
       # Public: The String transaction name (or nil).

data/lib/plaid/products/base_product.rb

@@ -60,10 +60,5 @@ module Plaid
     def post_with_auth(path, response_class, payload)
       response_class.new(client.post_with_auth(path, payload))
     end
-
-    # Internal: Do a POST to API and capture it into a response object.
-    def post_with_public_key(path, response_class, payload)
-      response_class.new(client.post_with_public_key(path, payload))
-    end
   end
 end

data/lib/plaid/products/institutions.rb

@@ -35,9 +35,9 @@ module Plaid
         institution_id: institution_id
       }
       payload[:options] = options unless options.nil?
-      post_with_public_key 'institutions/get_by_id',
-                           SingleInstitutionResponse,
-                           payload
+      post_with_auth 'institutions/get_by_id',
+                     SingleInstitutionResponse,
+                     payload
     end
 
     # Public: Get information about all available institutions matching your
@@ -59,9 +59,9 @@ module Plaid
 
       payload[:options] = options unless options.nil?
 
-      post_with_public_key 'institutions/search',
-                           MultipleInstitutionsResponse,
-                           payload
+      post_with_auth 'institutions/search',
+                     MultipleInstitutionsResponse,
+                     payload
     end
   end
 

data/lib/plaid/products/link_token.rb

@@ -0,0 +1,45 @@
+LINK_TOKEN_FIELD_NAMES = %i[
+  user
+  client_name
+  products
+  country_codes
+  language
+  webhook
+  access_token
+  link_customization_name
+  redirect_uri
+  android_package_name
+  account_filters
+  cross_app_item_add
+  payment_initiation
+].freeze
+
+module Plaid
+  # Public: Class used to call the LinkToken sub-product.
+  class LinkToken < BaseProduct
+    def create(configs)
+      body = {}
+
+      LINK_TOKEN_FIELD_NAMES.each do |field|
+        body[field] = configs[field]
+      end
+
+      post_with_auth 'link/token/create',
+                     CreateResponse,
+                     body
+    end
+  end
+
+  # Public: Response for /link/token/create.
+  class CreateResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The String token.
+    property :link_token
+
+    ##
+    # :attr_reader:
+    # Public: The String token expiration time.
+    property :expiration
+  end
+end

data/lib/plaid/products/sandbox.rb

@@ -102,11 +102,11 @@ module Plaid
       end
       options_payload = options_payload.merge(options) unless options.nil?
 
-      post_with_public_key 'sandbox/public_token/create',
-                           SandboxCreateResponse,
-                           institution_id: institution_id,
-                           initial_products: initial_products,
-                           options: options_payload
+      post_with_auth 'sandbox/public_token/create',
+                     SandboxCreateResponse,
+                     institution_id: institution_id,
+                     initial_products: initial_products,
+                     options: options_payload
     end
 
     private def transaction_options(start_date, end_date)

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '10.1.0'.freeze
+  VERSION = '11.0.0'.freeze
   API_VERSION = '2019-05-29'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaid
 version: !ruby/object:Gem::Version
-  version: 10.1.0
+  version: 11.0.0
 platform: ruby
 authors:
 - Edmund Loo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -174,6 +174,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".env.sample"
+- ".github/workflows/add_to_project.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -204,6 +205,7 @@ files:
 - lib/plaid/products/investments.rb
 - lib/plaid/products/item.rb
 - lib/plaid/products/liabilities.rb
+- lib/plaid/products/link_token.rb
 - lib/plaid/products/payment_initiation.rb
 - lib/plaid/products/processor.rb
 - lib/plaid/products/sandbox.rb
@@ -216,7 +218,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -232,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby bindings for Plaid
 test_files: []