mrkt 0.6.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 19c375fe88c8b99a1d7af83714409133424c3e7c
-  data.tar.gz: 88ebcda5a1b3dad3aaaf593552961d78a0e45512
+SHA256:
+  metadata.gz: 41d861185c2759674a5688a61bd06294e6ca18460bd1ff868df05bc3932018d5
+  data.tar.gz: e52dac6cb6ebbba08e079634c7ca72545c358e23305feffb254e243b3b741786
 SHA512:
-  metadata.gz: a5ca3432d050e8caf2d44edb44fcef9ef4f7840ee66dd7516ec8c38bf11e1c52e31151ee2b9d299bb210ae047a95add038f06c18e997104c74b96c81dc69b898
-  data.tar.gz: e44bd10fec6bc3477fcaf42e2939c78cdd7efa6fa1f348d39561022856eb7d01d5487f440e19bdfaafe68dacb2c9bb2892b1a61b63c0ede684750c39747935d7
+  metadata.gz: 5de0d92b43516840e7e71a83253414e157e5812ba00b6bb4bdada5b665c80a06cc24e6a89aec6e01b19515e72032cc6428075adf17acf56d12b48d7caee38545
+  data.tar.gz: 010fbf3fb5baa8f5a904c1858c938f6fd4d3f344c324b782aa1080a08343b6c7a8fd5f7f1a8c93a4c666cb361a7a2d2c9fd773a18f3bfe2ad6f39e7ce7f056c5

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ruby.yml

@@ -0,0 +1,41 @@
+name: Ruby
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0]
+
+    steps:
+      - uses: actions/checkout@v2.3.4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Update the RubyGems system software
+        run: gem update --system
+
+      - name: Update Bundler
+        run: bundle update --bundler
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests and publish coverage
+        uses: paambaati/codeclimate-action@v2.7.5
+        env:
+          COVERAGE: on
+          CC_TEST_REPORTER_ID: 45cd2174f49b570406e294ff393d456c4ae8532cf16dd6430abb06d8a0722a28
+        with:
+          coverageCommand: bundle exec rspec

data/.rubocop.yml

@@ -1,15 +1,40 @@
+require: rubocop-rake
+
 AllCops:
+  TargetRubyVersion: 2.5
   Exclude:
     - 'bin/**/*'
-Documentation:
+    - 'vendor/**/*'
+  NewCops: enable
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Layout/FirstHashElementIndentation:
   Enabled: false
-LineLength:
-  Enabled: true
-  Max: 120
-MethodLength:
+Layout/HashAlignment:
+  Enabled: false
+Layout/LineLength:
+  Max: 128
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/mrkt/concerns/connection.rb'
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+Metrics/MethodLength:
   Max: 20
-IndentHash:
+Metrics/ParameterLists:
+  Max: 6
+
+Naming/AccessorMethodName:
   Enabled: false
 
 Style/ClassAndModuleChildren:
   Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/Gemfile.lock

@@ -1,89 +1,115 @@
 PATH
   remote: .
   specs:
-    mrkt (0.6.2)
-      faraday_middleware (> 0.9.0, < 0.11.0)
+    mrkt (1.2.0)
+      faraday (~> 1.0)
+      faraday_middleware (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.8)
-    ast (2.0.0)
-    astrolabe (1.3.1)
-      parser (~> 2.2)
-    byebug (4.0.5)
-      columnize (= 0.9.0)
-    codeclimate-test-reporter (0.4.7)
-      simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
-    columnize (0.9.0)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    faraday (0.9.2)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    faraday (1.7.1)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.10.0)
-      faraday (>= 0.7.4, < 0.10)
-    json (1.8.2)
-    method_source (0.8.2)
-    multipart-post (2.0.0)
-    parser (2.2.2.6)
-      ast (>= 1.1, < 3.0)
-    powerpack (0.1.1)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (3.1.0)
-      byebug (~> 4.0)
-      pry (~> 0.10)
-    rainbow (2.0.0)
-    rake (10.1.1)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.2)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.1.0)
+      faraday (~> 1.0)
+    gem-release (2.2.2)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
-    rubocop (0.32.1)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.2.5, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.7.5)
-    safe_yaml (1.0.4)
-    simplecov (0.10.0)
-      docile (~> 1.1.0)
-      json (~> 1.8)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    slop (3.6.0)
-    webmock (1.21.0)
-      addressable (>= 2.3.6)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.3)
-  codeclimate-test-reporter (~> 0.4.7)
+  bundler (~> 2.0)
+  gem-release (~> 2.1)
   mrkt!
-  pry-byebug (~> 3.1.0)
-  rake (~> 10.0)
+  pry-byebug (~> 3.7)
+  rake (~> 13.0)
   rspec (~> 3.2)
-  rubocop (~> 0.32.1)
-  simplecov (~> 0.10.0)
-  webmock (~> 1.21.0)
+  rubocop (~> 1.20.0)
+  rubocop-rake (~> 0.6.0)
+  simplecov (~> 0.21.2)
+  webmock (~> 3.1)
 
 BUNDLED WITH
-   1.11.2
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 KARASZI István
+
+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

@@ -1,10 +1,12 @@
 # Mrkt
 
-[![Build Status](https://secure.travis-ci.org/raszi/mrkt.png)](http://travis-ci.org/raszi/mrkt)
+[![Build Status](https://travis-ci.org/raszi/mrkt.svg?branch=master)](https://travis-ci.org/raszi/mrkt)
 [![Code Climate](https://codeclimate.com/github/raszi/mrkt/badges/gpa.svg)](https://codeclimate.com/github/raszi/mrkt)
 [![Test Coverage](https://codeclimate.com/github/raszi/mrkt/badges/coverage.svg)](https://codeclimate.com/github/raszi/mrkt)
+[![Gem Version](https://badge.fury.io/rb/mrkt.svg)](https://badge.fury.io/rb/mrkt)
+[![Total Downloads](https://badgen.net/rubygems/dt/mrkt)](https://rubygems.org/gems/mrkt)
 
-This gem provides some level of abstraction to Marketo REST APIs. Please note that this gem is alpha quality. 
+This gem provides some level of abstraction to Marketo REST APIs. Please note that this gem is alpha quality.
 
 
 ## Installation
@@ -31,6 +33,7 @@ Get the following from your Marketo admin:
 * hostname, i.e. `'123-abc-123.mktorest.com'`
 * client id, e.g. `'4567e1cdf-0fae-4685-a914-5be45043f2d8'`
 * client secret, e.g. `'7Gn0tuiHZiDHnzeu9P14uDQcSx9xIPPt'`
+* partner id, e.g. `'335b1c91511b8d8b49c7bbf66f53288f16f37b60_a0147938d3135f8ddb5a75850ea3c39313fd23c4'` (optional)
 
 
 ## Usage
@@ -39,17 +42,42 @@ Get the following from your Marketo admin:
 
 ```ruby
 client = Mrkt::Client.new(
-  host: '123-abc-123.mktorest.com', 
-  client_id:  '4567e1cdf-0fae-4685-a914-5be45043f2d8', 
-  client_secret: '7Gn0tuiHZiDHnzeu9P14uDQcSx9xIPPt')
+  host: '123-abc-123.mktorest.com',
+  client_id:  '4567e1cdf-0fae-4685-a914-5be45043f2d8',
+  client_secret: '7Gn0tuiHZiDHnzeu9P14uDQcSx9xIPPt',
+  partner_id: '335b1c91511b8d8b49c7bbf66f53288f16f37b60_a0147938d3135f8ddb5a75850ea3c39313fd23c4' # optional 
+)
 ```
 
-If you need verbosity during troubleshooting, set the client to debug mode
+If you need verbosity during troubleshooting, enable debug mode:
 
 ```ruby
-client.debug = true
+client = Mrkt::Client.new(
+  host: '123-abc-123.mktorest.com',
+  client_id:  '4567e1cdf-0fae-4685-a914-5be45043f2d8',
+  client_secret: '7Gn0tuiHZiDHnzeu9P14uDQcSx9xIPPt',
+  debug: true,
+  logger: ::Logger.new("log/marketo.log"), # optional, defaults to Faraday default of logging to STDOUT
+  log_options: {bodies: true}) # optional, defaults to Faraday default of only logging headers
+```
+
+### Retry authentication
+
+Since the Marketo API provides API access keys with a validity of 3600 seconds, if you are running an hourly cronjob it's possible that your subsequent call receives the same key from the previous hour, which is then immediately expired. If this is the case, you can configure the client to retry until receiving a valid key:
+
+```ruby
+client = Mrkt::Client.new(
+  host: '123-abc-123.mktorest.com',
+  client_id:  '4567e1cdf-0fae-4685-a914-5be45043f2d8',
+  client_secret: '7Gn0tuiHZiDHnzeu9P14uDQcSx9xIPPt',
+  retry_authentication: true,
+  retry_authentication_count: 3, # default: 3
+  retry_authentication_wait_seconds: 1, # default: 0
+  )
 ```
 
+This is turned off by default.
+
 ### Get leads matching an email, print their id and email
     
 ```ruby

data/lib/mrkt/concerns/authentication.rb

@@ -1,8 +1,13 @@
 module Mrkt
   module Authentication
     def authenticate!
-      authenticate unless authenticated?
-      fail Mrkt::Errors::AuthorizationError, 'Client not authenticated' unless authenticated?
+      return if authenticated?
+
+      authenticate
+
+      retry_authentication if !authenticated? && @retry_authentication
+
+      raise Mrkt::Errors::AuthorizationError, 'Client not authenticated' unless authenticated?
     end
 
     def authenticated?
@@ -13,6 +18,15 @@ module Mrkt
       @valid_until && Time.now < @valid_until
     end
 
+    def retry_authentication
+      @retry_authentication_count.times do
+        sleep(@retry_authentication_wait_seconds) if @retry_authentication_wait_seconds.positive?
+        authenticate
+
+        break if authenticated?
+      end
+    end
+
     def authenticate
       connection.get('/identity/oauth/token', authentication_params).tap do |response|
         data = response.body
@@ -25,15 +39,27 @@ module Mrkt
     end
 
     def authentication_params
+      merge_params(required_authentication_params, optional_authentication_params)
+    end
+
+    def add_authorization(req)
+      req.headers[:authorization] = "Bearer #{@token}"
+    end
+
+    private
+
+    def optional_authentication_params
+      {
+        partner_id: @partner_id
+      }
+    end
+
+    def required_authentication_params
       {
         grant_type: 'client_credentials',
         client_id: @client_id,
         client_secret: @client_secret
       }
     end
-
-    def add_authorization(req)
-      req.headers[:authorization] = "Bearer #{@token}"
-    end
   end
 end

data/lib/mrkt/concerns/connection.rb

@@ -1,4 +1,4 @@
-require 'mrkt/faraday_middleware'
+require 'mrkt/faraday'
 
 module Mrkt
   module Connection
@@ -7,18 +7,27 @@ module Mrkt
     end
 
     def init_connection
-      Faraday.new(url: "https://#{@host}") do |conn|
+      ::Faraday.new(options) do |conn|
         conn.request :multipart
         conn.request :url_encoded
 
-        conn.response :logger if @debug
+        conn.response :logger, @logger, (@log_options || {}) if @debug
         conn.response :mkto, content_type: /\bjson$/
 
         conn.options.timeout = @options[:read_timeout] if @options.key?(:read_timeout)
         conn.options.open_timeout = @options[:open_timeout] if @options.key?(:open_timeout)
 
-        conn.adapter Faraday.default_adapter
+        conn.adapter @options.fetch(:adapter, ::Faraday.default_adapter)
       end
     end
+
+    def options
+      {
+        url: "https://#{@host}",
+        request: {
+          params_encoder: Mrkt::Faraday::ParamsEncoder
+        }
+      }
+    end
   end
 end

data/lib/mrkt/concerns/crud_activities.rb

@@ -0,0 +1,32 @@
+module Mrkt
+  module CrudActivities
+    def get_activity_types
+      get('/rest/v1/activities/types.json')
+    end
+
+    def get_paging_token(since_datetime)
+      get('/rest/v1/activities/pagingtoken.json', sinceDatetime: since_datetime.iso8601)
+    end
+
+    def get_activities(next_page_token, activity_type_ids: [], lead_ids: [])
+      params = {
+        nextPageToken: next_page_token
+      }
+
+      params[:activityTypeIds] = activity_type_ids unless blank?(activity_type_ids)
+      params[:leadIds] = lead_ids unless blank?(lead_ids)
+
+      get('/rest/v1/activities.json', params)
+    end
+
+    def get_deleted_leads(next_page_token)
+      get('/rest/v1/activities/deletedleads.json', nextPageToken: next_page_token)
+    end
+
+    private
+
+    def blank?(value)
+      !value || value == '' || value.empty?
+    end
+  end
+end

data/lib/mrkt/concerns/crud_asset_folders.rb

@@ -0,0 +1,43 @@
+module Mrkt
+  module CrudAssetFolders
+    def create_folder(name, parent, description: nil)
+      post('/rest/asset/v1/folders.json') do |req|
+        params = {
+          name: name,
+          parent: JSON.generate(parent)
+        }
+
+        optional = {
+          description: description
+        }
+
+        req.body = merge_params(params, optional)
+      end
+    end
+
+    def get_folder_by_id(id, type: nil)
+      params = {}
+      params[:type] = type if type
+
+      get("/rest/asset/v1/folder/#{id}.json", params)
+    end
+
+    def get_folder_by_name(name, type: nil, root: nil, work_space: nil)
+      params = {
+        name: name
+      }
+
+      optional = {
+        root: root&.to_json,
+        type: type,
+        workSpace: work_space
+      }
+
+      get('/rest/asset/v1/folder/byName.json', params, optional)
+    end
+
+    def delete_folder(id)
+      post("/rest/asset/v1/folder/#{id}/delete.json")
+    end
+  end
+end

data/lib/mrkt/concerns/crud_asset_static_lists.rb

@@ -0,0 +1,30 @@
+module Mrkt
+  module CrudAssetStaticLists
+    def create_static_list(name, folder, description: nil)
+      post('/rest/asset/v1/staticLists.json') do |req|
+        params = {
+          name: name,
+          folder: JSON.generate(folder)
+        }
+
+        optional = {
+          description: description
+        }
+
+        req.body = merge_params(params, optional)
+      end
+    end
+
+    def get_static_list_by_id(id)
+      get("/rest/asset/v1/staticList/#{id}.json")
+    end
+
+    def get_static_list_by_name(name)
+      get('/rest/asset/v1/staticList/byName.json', name: name)
+    end
+
+    def delete_static_list(id)
+      post("/rest/asset/v1/staticList/#{id}/delete.json")
+    end
+  end
+end

data/lib/mrkt/concerns/crud_campaigns.rb

@@ -1,15 +1,13 @@
 module Mrkt
   module CrudCampaigns
     def request_campaign(id, lead_ids, tokens = {})
-      post("/rest/v1/campaigns/#{id}/trigger.json") do |req|
-        params = {
+      post_json("/rest/v1/campaigns/#{id}/trigger.json") do
+        {
           input: {
             leads: map_lead_ids(lead_ids),
             tokens: tokens
           }
         }
-
-        json_payload(req, params)
       end
     end
   end

data/lib/mrkt/concerns/crud_custom_activities.rb

@@ -0,0 +1,36 @@
+require 'time'
+
+module Mrkt
+  module CrudCustomActivities
+    def get_list_of_custom_activity_types
+      warn 'DEPRECATED: Use #get_activity_types instead of #get_list_of_custom_activity_types!'
+      get_activity_types
+    end
+
+    def create_custom_activity(lead_id, activity_type_id, primary_attribute_value, attributes: {}, date: nil)
+      date ||= Time.now
+      date = date.utc.iso8601
+      converted_attributes = convert_attribute_hash(attributes)
+
+      input = [{
+        leadId: lead_id,
+        activityDate: date,
+        activityTypeId: activity_type_id,
+        primaryAttributeValue: primary_attribute_value,
+        attributes: converted_attributes
+      }]
+
+      post_json('/rest/v1/activities/external.json') do
+        { input: input }
+      end
+    end
+
+    private
+
+    def convert_attribute_hash(attributes)
+      attributes.map do |key, value|
+        { name: key, value: value }
+      end
+    end
+  end
+end