marketo_api 0.0.7.pre.alpha

data/lib/marketo_api/abstract_client.rb

@@ -0,0 +1,15 @@
+module MarketoApi
+  class AbstractClient
+    include MarketoApi::Concerns::Base
+    include MarketoApi::Concerns::Connection
+    include MarketoApi::Concerns::Authentication
+    include MarketoApi::Concerns::Caching
+
+    include MarketoApi::API::Base
+    include MarketoApi::API::Stats
+    include MarketoApi::API::Activities
+    include MarketoApi::API::Leads
+    include MarketoApi::API::Sales
+    include MarketoApi::API::Campaigns
+  end
+end

data/lib/marketo_api/api/activities.rb

@@ -0,0 +1,64 @@
+require 'time'
+
+module MarketoApi
+  module API
+    module Activities
+      include Base
+
+      # Public: Returns a detailed describe result for the specified activities
+      #
+      # Example
+      #   # get the describe for the Activities object
+      #   client.activities_describe
+      #   # => { ... }
+      #
+      # Returns the Hash representation of the describe call.
+      def activities_describe
+        api_get('activities/types.json')
+      end
+
+      def paging_token(start_time)
+        # FIXME: (MT) Need to make sure `start_time` is a `Time` obj
+        if start_time
+          mod_time = start_time.iso8601
+        else
+          mod_time = Time.now.iso8601
+        end
+
+        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
+          "activityTypeIds=#{ids}"
+        else
+          ""
+        end
+      end
+
+      # FIXME: (MT) Refactor this
+      def activities_by_lead_ids(lead_ids, type_ids, next_page_token=nil)
+        # FIXME: (MT) Raise an error when lead_ids is empty
+        path = "activities.json"
+        path << "?leadIds=#{format_filter_values(lead_ids)}" if lead_ids
+        path << "&#{add_activity_type_ids(type_ids)}" if type_ids
+        api_get(add_next_page_token(path, next_page_token))
+      end
+
+      # FIXME: (MT) Refactor this
+      def activities_by_type_id(type_ids, next_page_token=nil)
+        # FIXME: (MT) Rename method to support plural (type_ids)
+        # FIXME: (MT) Raise an error when type_ids is empty
+        path = "activities.json"
+        path << "?#{add_activity_type_ids(type_ids)}" if type_ids
+        api_get(add_next_page_token(path, next_page_token))
+      end
+    end
+  end
+end

data/lib/marketo_api/api/base.rb

@@ -0,0 +1,63 @@
+require 'uri'
+require 'marketo_api/concerns/verbs'
+
+module MarketoApi
+  module API
+    module Base
+      extend MarketoApi::Concerns::Verbs
+
+      # Public: Helper methods for performing arbitrary actions against the API using
+      # various HTTP verbs.
+      #
+      # Examples
+      #
+      #   # Perform a get request
+      #   client.get '/rest/v1/leads'
+      #   client.api_get 'leads'
+      #
+      # Returns the Faraday::Response.
+      define_verbs :get, :post, :put, :delete, :patch, :head
+
+      # TODO: (MT) Move this to a helper
+      def format_filter_values(filter_values)
+        filter_values = filter_values.join(',') if filter_values.is_a?(Array)
+        filter_values
+      end
+
+      private
+
+      # Internal: Returns a path to an api endpoint
+      #
+      # Examples
+      #
+      #   api_path('leads')
+      #   # => '/rest/v1/leads'
+      def api_path(path)
+        "/rest/v#{options[:api_version]}/#{path}"
+      end
+
+      # Internal: Ensures that the `api_version` set for the Marketo client is at least
+      # the provided version before performing a particular action
+      def version_guard(version)
+        if version.to_f <= options[:api_version].to_f
+          yield
+        else
+          raise APIVersionError, "You must set an `api_version` of at least #{version} "
+        end
+      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)
+        value ||= hash.delete(key.to_s.downcase)
+        value ||= hash.delete(key.to_s.downcase.to_sym)
+        value
+      end
+
+      # Internal: Errors that should be rescued from in non-bang methods
+      def exceptions
+        [Faraday::Error::ClientError]
+      end
+    end
+  end
+end

data/lib/marketo_api/api/campaigns.rb

@@ -0,0 +1,70 @@
+module MarketoApi
+  module API
+    module Campaigns
+      include Base
+
+      # Public: Executes specific entity request and returns the result.
+      #
+      # Example
+      #   # Find the specific campaign
+      #   client.campaign_by_id(3711)
+      #   # => {
+      #          "requestId": "717#15f4b51ed20"
+      #          "success": "true"
+      #          "result": [
+      #            {
+      #              "id": "3711"
+      #              "name": "John Clark - Smart Campaign"
+      #              "type": "trigger"
+      #              "programName": "John Clark - Request Campaign.John Clark - Email Program"
+      #              "programId": "1073"
+      #              "workspaceName": "Default"
+      #              "createdAt": "'2017-02-13T19:58:56Z'"
+      #              "updatedAt": "'2017-02-13T20:06:29Z'"
+      #              "active": "true"
+      #            }
+      #          ]
+      #        }
+      def campaign_by_id(id)
+        api_get("campaigns/#{id}.json")
+      end
+
+      # Public: Returns a list of campaign records.
+      # Required Permissions: Read-Only Campaigns, Read-Write Campaigns
+      #
+      # Example
+      #   # Find the specific campaign
+      #   client.campaigns_by_workspace(true)
+      #   # => {
+      #          "requestId": "cab#15f4b36d1ca"
+      #          "success": "true"
+      #          "result": [
+      #            {
+      #              "id": "3711"
+      #              "name": "John Clark - Smart Campaign"
+      #              "type": "trigger"
+      #              "programName": "John Clark - Request Campaign.John Clark - Email Program"
+      #              "programId": "1073"
+      #              "workspaceName": "Default"
+      #              "createdAt": "'2017-02-13T19:58:56Z'"
+      #              "updatedAt": "'2017-02-13T20:06:29Z'"
+      #              "active": "true"
+      #            }
+      #          ]
+      #        }
+      #
+      # If no records are found, the following is returned:
+      # # => {
+      #        "requestId": "13cc0#15f4b5134af",
+      #        "result": [],
+      #        "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}")
+      end
+    end
+  end
+end

data/lib/marketo_api/api/leads.rb

@@ -0,0 +1,86 @@
+module MarketoApi
+  module API
+    module Leads
+      include Base
+
+      # Public: Returns a detailed describe result for the specified leads
+      #
+      # Example
+      #   # get the describe for the Leads object
+      #   client.leads_describe
+      #   # => { ... }
+      #
+      # Returns the Hash representation of the describe call.
+      def leads_describe
+        api_get('leads/describe.json')
+      end
+
+      # Public: Executes specific entity request and returns the result.
+      #
+      # Example
+      #   # Find the specific lead
+      #   client.leads_by_id(318581)
+      #   # => {
+      #         "requestId": "10226#14d3049e51b",
+      #         "success": true,
+      #         "result": [
+      #            {
+      #               "id": 318581,
+      #               "updatedAt":"2015-05-07T11:47:30-08:00"
+      #               "lastName": "Doe",
+      #               "email": "jdoe@marketo.com",
+      #               "createdAt": "2015-05-01T16:47:30-08:00",
+      #               "firstName": "John"
+      #            }
+      #         ]
+      #      }
+      #
+      def leads_by_id(id)
+        api_get("leads/#{id}.json")
+      end
+
+      # Public: Executes specific filterType with filterValues request
+      # and returns the result.
+      #
+      # Example
+      #   # Find the specific lead
+      #   client.leads_by_filter_type('email',
+      #                               ['abe@usa.gov', 'george@usa.gov'])
+      #   # => {
+      #     "requestId": "12951#15699db5c97",
+      #     "result": [
+      #       {
+      #           "id": 318581,
+      #           "updatedAt": "2016-05-17T22:11:45Z",
+      #           "lastName": "Lincoln",
+      #           "email": "abe@usa.gov",
+      #           "createdAt": "2015-03-17T00:18:40Z",
+      #           "firstName": "Abraham"
+      #       },
+      #       {
+      #           "id": 318592,
+      #           "updatedAt": "2016-05-17T22:20:51Z",
+      #           "lastName": "Washington",
+      #           "email": "george@usa.gov",
+      #           "createdAt": "2015-04-06T16:29:21Z",
+      #           "firstName": "George"
+      #       }
+      #     ],
+      #     "success": true
+      #   }
+      #
+      # If no records are found, the following is returned:
+      # # => {
+      #        "requestId": "177a1#1578b643357",
+      #        "result": [],
+      #        "success": true
+      #      }
+      #
+      def leads_by_filter_type(filter_type, filter_values)
+        type_param = "filterType=#{filter_type}"
+        values_param = "filterValues=#{format_filter_values(filter_values)}"
+        api_get("leads.json?#{type_param}&#{values_param}")
+      end
+    end
+  end
+end

data/lib/marketo_api/api/sales.rb

@@ -0,0 +1,19 @@
+module MarketoApi
+  module API
+    module Sales
+      include Base
+
+      def best_bets(attrs)
+        api_get('sales/bestbets.json', attrs)
+      end
+
+      def interesting_moments(attrs)
+        api_get('sales/interestingmoments.json', attrs)
+      end
+
+      def create_activity!(attrs)
+        api_post('sales/activities.json', attrs)
+      end
+    end
+  end
+end

data/lib/marketo_api/api/stats.rb

@@ -0,0 +1,54 @@
+module MarketoApi
+  module API
+    module Stats
+      include Base
+
+      # Public: Returns the daily usage of API requests
+      #
+      # Example
+      #   client.daily_usage
+      #   # => { ... }
+      #
+      # Returns the Hash representation of the usage call.
+      def daily_usage
+        api_get('stats/usage.json')
+      end
+
+      # Public: Returns the count of each error type encountered
+      # in the current day
+      #
+      # Example
+      #   client.daily_errors
+      #   # => { ... }
+      #
+      # Returns the Hash representation of the usage call.
+      def daily_errors
+        api_get('stats/errors.json')
+      end
+
+      # Public: Returns a list of API users and the number of calls
+      # they have consumed in the past 7 days.
+      #
+      # Example
+      #   client.weekly_usage
+      #   # => { ... }
+      #
+      # Returns the Hash representation of the usage call.
+      def weekly_usage
+        api_get('stats/usage/last7days.json')
+      end
+
+      # Public: Returns a list of API users and a count of each error type
+      # they have encountered in the past 7 days
+      #
+      # Example
+      #   client.weekly_errors
+      #   # => { ... }
+      #
+      # Returns the Hash representation of the usage call.
+      def weekly_errors
+        api_get('stats/errors/last7days.json')
+      end
+    end
+  end
+end

data/lib/marketo_api/client.rb

@@ -0,0 +1,8 @@
+module MarketoApi
+  class Client < AbstractClient
+    # Public: Returns a url to the resource.
+    def url
+      "#{instance_url}/rest/"
+    end
+  end
+end

data/lib/marketo_api/concerns/authentication.rb

@@ -0,0 +1,20 @@
+module MarketoApi
+  module Concerns
+    module Authentication
+      # Public: Force an authentication
+      def authenticate!
+        unless authentication_middleware
+          fail AuthenticationError.new('No authentication middleware present')
+        end
+
+        middleware = authentication_middleware.new nil, self, options
+        middleware.authenticate!
+      end
+
+      # Internal: Determines what middleware will be used based on the options provided
+      def authentication_middleware
+        MarketoApi::Middleware::Authentication::Token
+      end
+    end
+  end
+end

data/lib/marketo_api/concerns/base.rb

@@ -0,0 +1,49 @@
+module MarketoApi
+  module Concerns
+    module Base
+      attr_reader :options
+
+      # Public: Creates a new client instance
+      #
+      # opts - A hash of options to be passed in (default: {}).
+      #        :oauth_token             - The String oauth access token to authenticate
+      #                                   API calls (required unless password
+      #                                   authentication is used).
+      #        :instance_url            - The String base url for all api requests
+      #                                   (required if oauth authentication is used).
+      #
+      #        :client_id               - The oauth client id to use. Needed for both
+      #                                   password and oauth authentication
+      #        :client_secret           - The oauth client secret to use.
+      #
+      #        :api_version             - The String REST api version to use
+      #                                   (default: '24.0')
+      #
+      #        :timeout                 - Faraday connection request read/open timeout.
+      #                                   (default: nil).
+      #
+      #        :request_headers         - A hash containing custom headers that will be
+      #                                   appended to each request
+
+      def initialize(opts = {})
+        fail ArgumentError.new('Please specify a hash of options') unless opts.is_a?(Hash)
+
+        @options = Hash[MarketoApi.configuration.options.map do |option|
+          [option, MarketoApi.configuration.send(option)]
+        end]
+
+        @options.merge! opts
+        yield builder if block_given?
+      end
+
+      def instance_url
+        authenticate! unless options[:instance_url]
+        options[:instance_url]
+      end
+
+      def inspect
+        "#<#{self.class} @options=#{@options.inspect}>"
+      end
+    end
+  end
+end