marketo_api 0.0.7.pre.alpha → 0.1.1.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0e4a69bf5f1286d61ac226604d905bf1b3dee26b
-  data.tar.gz: 97b0aef343a1d57180b22583b7e6befaf8d85035
+SHA256:
+  metadata.gz: b66ff88fcb787f69745f1119bfa69298cca89aec9e3446a12cc5688e3b4cf2f5
+  data.tar.gz: 7bbbed4b3ba4c557dd54f3ad212f8029fcbbd953d5537ab7e16c39c58ea46a71
 SHA512:
-  metadata.gz: 62bc0d5a6185484f7e26de757177ba17776a418df1c3056714532d10198002a4a2580ea308be7ce4fedaf99366ee7bf97ba30e597bbc28087dc06f7e6ba9ae07
-  data.tar.gz: 1fdfb44bca20e8189c0c6023774d7f2a72a0f993765a8127940a0607305eeb85be5cdbc384e87612259c5eef41bb7774a2faa06548922ece95e1a48f0a6af60c
+  metadata.gz: b9db3ec1fe011c9e759ed589e2ca17baac5bd5f35ab56f096e2c9ab8c232b225b80d55cdf97755372607cc9905008a45c0d38c1b3991cd76925d7df1aa267c92
+  data.tar.gz: 39b6e083bf6123d7021e7186df8eb651d07516022eb3e81c4e4f5d54a4dac94d6181123473ab63dec28aead571dd7c74d8b049e702edd61e01d79d69579aae10

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+## What's in here
+
+
+
+### Related PRs
+
+- n/a
+
+### Related Stories
+
+- n/a
+
+### Notes
+
+none

data/.travis.yml

@@ -1,8 +1,5 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
   - 2.3.0
 before_script:
   - bin/setup

data/History.md

@@ -0,0 +1,5 @@
+
+0.1.0 / 2018-02-23
+==================
+
+  * Implement Workspaces API

data/lib/marketo_api.rb

@@ -25,6 +25,7 @@ module MarketoApi
     autoload :Stats,          'marketo_api/api/stats'
     autoload :Activities,     'marketo_api/api/activities'
     autoload :Campaigns,      'marketo_api/api/campaigns'
+    autoload :Workspaces,     'marketo_api/api/workspaces'
   end
 
   Error               = Class.new(StandardError)

data/lib/marketo_api/abstract_client.rb

@@ -11,5 +11,6 @@ module MarketoApi
     include MarketoApi::API::Leads
     include MarketoApi::API::Sales
     include MarketoApi::API::Campaigns
+    include MarketoApi::API::Workspaces
   end
 end

data/lib/marketo_api/api/activities.rb

@@ -28,11 +28,6 @@ module MarketoApi
         api_get("activities/pagingtoken.json?sinceDatetime=#{mod_time}")
       end
 
-      def add_next_page_token(path, token)
-        path = "#{path}&nextPageToken=#{token}" if token
-        path
-      end
-
       def add_activity_type_ids(type_ids)
         ids = format_filter_values(type_ids)
         if ids

data/lib/marketo_api/api/base.rb

@@ -46,6 +46,38 @@ module MarketoApi
         end
       end
 
+      # Internal: Converts a hash into a string that can be consumed by
+      # the Marketo API as a query string
+      #
+      # Examples
+      #
+      #   to_query({ source: 'Sales Engage', workspaceName: 'Global' })
+      #   # => 'source=Sales%20Engage&workspaceName=Global'
+      def to_query(options = {})
+        options.to_query.gsub('+', '%20')
+      end
+
+      # Internal: Append a nextPageToken to a url if token is present
+      #
+      # Examples
+      #
+      #   add_next_page_token('activities.json?')
+      #   # => '/rest/v1/leads'
+      def add_next_page_token(path, token)
+        path += "&nextPageToken=#{token}" if token
+        path
+      end
+
+      # Internal: Returns hash for next page token param
+      #
+      # Examples
+      #
+      #   add_next_page_token('123')
+      #   # => { nextPageToken: '123' }
+      def paging_token_param(token)
+        token.present? ? { nextPageToken: token } : {}
+      end
+
       def extract_case_insensitive_string_or_symbol_key_from_hash!(hash, key)
         value = hash.delete(key.to_sym)
         value ||= hash.delete(key.to_s)

data/lib/marketo_api/api/campaigns.rb

@@ -34,7 +34,7 @@ module MarketoApi
       #
       # Example
       #   # Find the specific campaign
-      #   client.campaigns_by_workspace(true)
+      #   client.campaigns_by_workspace('Default')
       #   # => {
       #          "requestId": "cab#15f4b36d1ca"
       #          "success": "true"
@@ -60,10 +60,65 @@ module MarketoApi
       #        "success": true
       #      }
       #
-      def campaigns_by_workspace(is_triggerable, workspace_name = 'Default')
-        triggerable_param = "isTriggerable=#{is_triggerable ? 1 : 0}"
-        workspace_param = "workspaceName=#{workspace_name}"
-        api_get("campaigns.json?#{triggerable_param}&#{workspace_param}")
+      def campaigns_by_workspace(workspace_name = 'Default', options = {})
+        options[:workspaceName] = workspace_name
+        campaigns(options)
+      end
+
+      def campaigns_next_page(next_page_token, options = {})
+        campaigns(options.merge(paging_token_param(next_page_token)))
+      end
+
+      def campaigns(options = {})
+        options_query = to_query(options)
+        api_get("campaigns.json?#{options_query}")
+      end
+
+      # Public: Passes a set of leads to a trigger campaign to run through the campaign's flow.
+      # The designated campaign must have a Campaign is Requested: Web Service API trigger, and
+      # must be active. My tokens local to the campaign's parent program can be overridden for
+      # the run to customize content.
+      #
+      # Required Permissions: Execute Campaign
+      #
+      #
+      # Example
+      #   # Add lead to trigger campaign
+      #   client.trigger_campaign!(3711, {})
+      #   # => {
+      #          "errors": [
+      #            {
+      #              "code": 0,
+      #              "message": "string"
+      #            }
+      #          ],
+      #          "moreResult": false,
+      #          "nextPageToken": "string",
+      #          "requestId": "string",
+      #          "result": [
+      #            {
+      #              "active": false,
+      #              "createdAt": "string",
+      #              "description": "string",
+      #              "id": 0,
+      #              "name": "string",
+      #              "programId": 0,
+      #              "programName": "string",
+      #              "type": "batch",
+      #              "updatedAt": "string",
+      #              "workspaceName": "string"
+      #            }
+      #          ],
+      #          "success": false,
+      #          "warnings": [
+      #            {
+      #              "code": 0,
+      #              "message": "string"
+      #            }
+      #          ]
+      #        }
+      def trigger_campaign!(campaign_id, attrs)
+        api_post("campaigns/#{campaign_id}/trigger.json", attrs)
       end
     end
   end

data/lib/marketo_api/api/workspaces.rb

@@ -0,0 +1,25 @@
+module MarketoApi
+  module API
+    module Workspaces
+      include Base
+
+      # Public: Returns an array of workspaces for the current user.
+      # Example
+      # client.user_workspaces
+      # => [{
+      #       "id": 102,
+      #       "name": "A cool Marketo workspace",
+      #       "description": "This workspace is amazing!",
+      #       "globalViz": 0,
+      #       "status": "active",
+      #       "currencyInfo": nil,
+      #       "createdAt": "20180112T18:07:09.0t+0000",
+      #       "updatedAt": "20180112T18:07:09.0t+0000"
+      #    }]
+
+      def user_workspaces
+        get("userservice/lm/v1/workspaces/")
+      end
+    end
+  end
+end

data/lib/marketo_api/version.rb

@@ -1,3 +1,3 @@
 module MarketoApi
-  VERSION = '0.0.7-alpha'.freeze
+  VERSION = '0.1.1-alpha'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marketo_api
 version: !ruby/object:Gem::Version
-  version: 0.0.7.pre.alpha
+  version: 0.1.1.pre.alpha
 platform: ruby
 authors:
 - Ami Bhatt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -201,6 +201,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -208,6 +209,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - Guardfile
+- History.md
 - LICENSE
 - README.md
 - Rakefile
@@ -226,6 +228,7 @@ files:
 - lib/marketo_api/api/leads.rb
 - lib/marketo_api/api/sales.rb
 - lib/marketo_api/api/stats.rb
+- lib/marketo_api/api/workspaces.rb
 - lib/marketo_api/client.rb
 - lib/marketo_api/concerns/authentication.rb
 - lib/marketo_api/concerns/base.rb
@@ -262,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Marketo REST API ruby gem