mrkt 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9c4c184b895beed1d39507db68cd1826fd709588
-  data.tar.gz: f2fcf806aa0f17d07ee67034eeabe09159ef1b60
+SHA256:
+  metadata.gz: c6240df5d2fc5e237cb846da72b226f71b836d86e466aff3ee96854ff0c9087f
+  data.tar.gz: a20eea282f97ad58e45d780bfc88c32305bae0c127feb819be7f93aa26010dc5
 SHA512:
-  metadata.gz: eb54c671fa877899ab5161db7446d0b142684a0fed8ed05cf7b3e533827a229a32603e40e6500b971196e91dab13864bd79ef0147d9a523e3eaf2122548ba9d5
-  data.tar.gz: bfb9caab6508464ecc878d9e0b17a3c69b0f72f75f84d3e611f60aa2e3384d2ef961dd25e4d81f904f81685791e173dac5b809cf16df763e6dfb9a631e5281b9
+  metadata.gz: 5e4878202b8cf696c8e9434688f21c648770f32a393d7128efe1b90e89c1e78d76b00c447c83c295f72cdc8399f7ffe6a526b7a972a45107abe1c0ea53a42217
+  data.tar.gz: 14c64d83473c35eaec901b1be3e921d1de1e211cf8db989fa91bb3e2fa389303d27bdf6adc7af77bcedcc9de6aaf8aaaa3adefb04f0748d12f680d29fcdcd716

data/.rubocop.yml

@@ -1,17 +1,71 @@
 AllCops:
+  TargetRubyVersion: 2.5
   Exclude:
     - 'bin/**/*'
-Documentation:
+    - 'vendor/**/*'
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Layout/FirstHashElementIndentation:
   Enabled: false
-LineLength:
+Layout/HashAlignment:
+  Enabled: false
+Layout/LineLength:
+  Max: 128
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
   Enabled: true
-  Max: 120
-MethodLength:
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 17
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+Metrics/MethodLength:
   Max: 20
-IndentHash:
+Metrics/ParameterLists:
+  Max: 6
+
+Naming/AccessorMethodName:
   Enabled: false
 
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
 Style/ClassAndModuleChildren:
   Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
 Style/FrozenStringLiteralComment:
   Enabled: false
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

data/.travis.yml

@@ -1,12 +1,21 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=45cd2174f49b570406e294ff393d456c4ae8532cf16dd6430abb06d8a0722a28
+    - COVERAGE=on
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.8
-  - 2.3.5
-  - 2.4.2
-addons:
-  code_climate:
-    repo_token: 45cd2174f49b570406e294ff393d456c4ae8532cf16dd6430abb06d8a0722a28
-after_success:
-  - bundle exec codeclimate-test-reporter
+  - 2.5
+  - 2.6
+  - 2.7
+before_install:
+  - gem update --system
+  - bundle update --bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile.lock

@@ -1,90 +1,95 @@
 PATH
   remote: .
   specs:
-    mrkt (0.8.0)
-      faraday (> 0.9.0, < 0.14.0)
-      faraday_middleware (> 0.9.0, < 0.13.0)
+    mrkt (1.0.0)
+      faraday (~> 1.0)
+      faraday_middleware (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.1)
-      public_suffix (~> 2.0, >= 2.0.2)
-    ast (2.3.0)
-    byebug (9.0.6)
-    codeclimate-test-reporter (1.0.7)
-      simplecov
-    coderay (1.1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    faraday (0.10.1)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.10.1)
-      faraday (>= 0.7.4, < 1.0)
-    json (2.1.0)
-    method_source (0.8.2)
-    multipart-post (2.0.0)
-    parser (2.4.0.0)
-      ast (~> 2.2)
-    powerpack (0.1.1)
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (3.4.2)
-      byebug (~> 9.0)
-      pry (~> 0.10)
-    public_suffix (2.0.5)
-    rainbow (2.2.2)
-      rake
-    rake (10.5.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    gem-release (2.1.1)
+    hashdiff (1.0.1)
+    json (2.3.1)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      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.5)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    rubocop (0.45.0)
-      parser (>= 2.3.1.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.87.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    safe_yaml (1.0.4)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.17.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.1)
-    slop (3.6.0)
-    unicode-display_width (1.3.0)
-    webmock (1.21.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.7.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.3)
-  codeclimate-test-reporter (~> 1.0.0)
+  gem-release (~> 2.1)
   mrkt!
-  pry-byebug (~> 3.4.0)
-  rake (~> 10.0)
+  pry-byebug (~> 3.7)
+  rake (~> 12.3)
   rspec (~> 3.2)
-  rubocop (~> 0.45.0)
-  simplecov (~> 0.14.1)
-  webmock (~> 1.21.0)
+  rubocop (~> 0.87.1)
+  simplecov (~> 0.17.1)
+  webmock (~> 3.1)
 
 BUNDLED WITH
-   1.15.4
+   1.17.3

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,11 @@
 # 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)
 
-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 +32,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 +41,19 @@ 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, enable debug mode:
 
 ```ruby
 client = Mrkt::Client.new(
-  host: '123-abc-123.mktorest.com', 
-  client_id:  '4567e1cdf-0fae-4685-a914-5be45043f2d8', 
+  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

data/lib/mrkt.rb

@@ -9,9 +9,12 @@ require 'mrkt/concerns/crud_campaigns'
 require 'mrkt/concerns/crud_leads'
 require 'mrkt/concerns/crud_lists'
 require 'mrkt/concerns/import_leads'
+require 'mrkt/concerns/import_custom_objects'
 require 'mrkt/concerns/crud_custom_objects'
 require 'mrkt/concerns/crud_custom_activities'
 require 'mrkt/concerns/crud_programs'
+require 'mrkt/concerns/crud_asset_static_lists'
+require 'mrkt/concerns/crud_asset_folders'
 
 module Mrkt
   class Client
@@ -23,9 +26,12 @@ module Mrkt
     include CrudLeads
     include CrudLists
     include ImportLeads
+    include ImportCustomObjects
     include CrudCustomObjects
     include CrudCustomActivities
     include CrudPrograms
+    include CrudAssetStaticLists
+    include CrudAssetFolders
 
     attr_accessor :debug
 
@@ -34,6 +40,7 @@ module Mrkt
 
       @client_id = options.fetch(:client_id)
       @client_secret = options.fetch(:client_secret)
+      @partner_id = options[:partner_id]
 
       @retry_authentication = options.fetch(:retry_authentication, false)
       @retry_authentication_count = options.fetch(:retry_authentication_count, 3).to_i
@@ -47,13 +54,19 @@ module Mrkt
       @options = options
     end
 
-    %i(get post delete).each do |http_method|
-      define_method(http_method) do |path, payload = {}, &block|
+    def merge_params(params, optional)
+      params.merge(optional.keep_if { |_key, value| value })
+    end
+
+    %i[get post delete].each do |http_method|
+      define_method(http_method) do |path, params = {}, optional = {}, &block|
         authenticate!
 
+        payload = merge_params(params, optional)
+
         resp = connection.send(http_method, path, payload) do |req|
           add_authorization(req)
-          block.call(req) unless block.nil?
+          block&.call(req)
         end
 
         resp.body

data/lib/mrkt/concerns/authentication.rb

@@ -5,15 +5,9 @@ module Mrkt
 
       authenticate
 
-      if !authenticated? && @retry_authentication
-        @retry_authentication_count.times do
-          sleep(@retry_authentication_wait_seconds) if @retry_authentication_wait_seconds > 0
-          authenticate
-          break if authenticated?
-        end
-      end
+      retry_authentication if !authenticated? && @retry_authentication
 
-      fail Mrkt::Errors::AuthorizationError, 'Client not authenticated' unless authenticated?
+      raise Mrkt::Errors::AuthorizationError, 'Client not authenticated' unless authenticated?
     end
 
     def authenticated?
@@ -24,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
@@ -36,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