mrkt 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d12dd686225c6c59e0f4441adb10a1083e772080
-  data.tar.gz: ac0595a8e7e88a52cfcf87ff2cf3fa3967144a80
+  metadata.gz: 19c375fe88c8b99a1d7af83714409133424c3e7c
+  data.tar.gz: 88ebcda5a1b3dad3aaaf593552961d78a0e45512
 SHA512:
-  metadata.gz: dd7a1923389e9412dc1e82e943627a27e1b214bebc14d75a4f88fe90b1703a22cb7d45104b00409fd69cfff696078b345ecd5f0f415f9cb138049088da130ed2
-  data.tar.gz: 210a3568aa5888b0eced93b20e6a8b3fbfc81465757608546dae933d638e24d603a40412d7260119fb28ff4b3762b511f876d5f96c4c50af875e5356a3e823bd
+  metadata.gz: a5ca3432d050e8caf2d44edb44fcef9ef4f7840ee66dd7516ec8c38bf11e1c52e31151ee2b9d299bb210ae047a95add038f06c18e997104c74b96c81dc69b898
+  data.tar.gz: e44bd10fec6bc3477fcaf42e2939c78cdd7efa6fa1f348d39561022856eb7d01d5487f440e19bdfaafe68dacb2c9bb2892b1a61b63c0ede684750c39747935d7

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.swp

data/.travis.yml

@@ -3,5 +3,6 @@ rvm:
   - 2.0.0
   - 2.1.5
   - 2.2.0
+  - 2.3.1
 addons:
   code_climate: 45cd2174f49b570406e294ff393d456c4ae8532cf16dd6430abb06d8a0722a28

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    mrkt (0.6.1)
-      faraday_middleware (~> 0.9.1)
+    mrkt (0.6.2)
+      faraday_middleware (> 0.9.0, < 0.11.0)
 
 GEM
   remote: https://rubygems.org/
@@ -21,9 +21,9 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    faraday (0.9.1)
+    faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.9.1)
+    faraday_middleware (0.10.0)
       faraday (>= 0.7.4, < 0.10)
     json (1.8.2)
     method_source (0.8.2)
@@ -86,4 +86,4 @@ DEPENDENCIES
   webmock (~> 1.21.0)
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/README.md

@@ -53,7 +53,7 @@ client.debug = true
 ### Get leads matching an email, print their id and email
     
 ```ruby
-response = client.get_leads(:email, 'sammy@acme.com')
+response = client.get_leads(:email, ['sammy@acme.com'])
 response[:result].each do |result|
   p "id: #{result[:id]}, email: #{result[:email]}"
 end

data/lib/mrkt.rb

@@ -8,6 +8,8 @@ require 'mrkt/concerns/crud_campaigns'
 require 'mrkt/concerns/crud_leads'
 require 'mrkt/concerns/crud_lists'
 require 'mrkt/concerns/import_leads'
+require 'mrkt/concerns/crud_custom_objects'
+require 'mrkt/concerns/crud_programs'
 
 module Mrkt
   class Client
@@ -18,6 +20,8 @@ module Mrkt
     include CrudLeads
     include CrudLists
     include ImportLeads
+    include CrudCustomObjects
+    include CrudPrograms
 
     attr_accessor :debug
 

data/lib/mrkt/concerns/crud_custom_objects.rb

@@ -0,0 +1,53 @@
+module Mrkt
+  module CrudCustomObjects
+    def get_list_of_custom_objects(names=nil)
+      params = {}
+      params[:names] = names.join(',') if names
+
+      get('/rest/v1/customobjects.json', params)
+    end
+
+    def describe_custom_object(name)
+      fail Mrkt::Errors::Unknown unless name
+
+      get("/rest/v1/customobjects/#{name}/describe.json")
+    end
+
+    def createupdate_custom_objects(name, input, action: 'createOrUpdate', dedupe_by: 'dedupeFields')
+      post("/rest/v1/customobjects/#{name}.json") do |req|
+        params = {
+          input: input,
+          action: action,
+          dedupeBy: dedupe_by
+        }
+        json_payload(req, params)
+      end
+    end
+
+    def delete_custom_objects(name, input, delete_by: 'dedupeFields')
+      post("/rest/v1/customobjects/#{name}/delete.json") do |req|
+        params = {
+          input: input,
+          deleteBy: delete_by
+        }
+
+        json_payload(req, params)
+      end
+    end
+
+    def get_custom_objects(name, input, filter_type: 'dedupeFields', fields: nil, next_page_token: nil, batch_size: nil)
+      post("/rest/v1/customobjects/#{name}.json?_method=GET") do |req|
+        params = {
+          input: input,
+          filterType: filter_type
+        }
+
+        params[:fields] = fields if fields
+        params[:nextPageToken] = next_page_token if next_page_token
+        params[:batchSize] = batch_size if batch_size
+
+        json_payload(req, params)
+      end
+    end
+  end
+end

data/lib/mrkt/concerns/crud_programs.rb

@@ -0,0 +1,16 @@
+module Mrkt
+  module CrudPrograms
+    def browse_programs(offset: nil, max_return: nil, status: nil)
+      params = {}
+      params[:offset] = offset if offset
+      params[:maxReturn] = max_return if max_return
+      params[:status] = status if status
+
+      get('/rest/asset/v1/programs.json', params)
+    end
+
+    def get_program_by_id(id)
+      get("/rest/asset/v1/program/#{id}.json")
+    end
+  end
+end

data/lib/mrkt/version.rb

@@ -1,3 +1,3 @@
 module Mrkt
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

data/mrkt.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.0'
 
-  spec.add_dependency 'faraday_middleware', '~> 0.9.1'
+  spec.add_dependency 'faraday_middleware', '> 0.9.0', '< 0.11.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 10.0'

data/spec/concerns/crud_custom_objects_spec.rb

@@ -0,0 +1,259 @@
+describe Mrkt::CrudCustomObjects do
+  include_context 'initialized client'
+
+  describe '#get_list_of_custom_objects' do
+    let(:response_stub) do
+      {
+        requestId: 'c245#14cd6830ae2',
+        result: [{
+          name: 'device_c',
+          displayName: 'Device',
+          description: 'this is a device object',
+          createdAt: '2016-01-23T00:51:18Z',
+          updatedAt: '2016-01-23T00:51:18Z',
+          idField: 'marketoGUID',
+          dedupeFields: ['serialNumber'],
+          searchableFields: [['serialNumber'], ['marketoGUID']],
+          relationships: [{
+              field: 'email',
+              type: 'child',
+              relatedTo: { name: 'Lead', field: 'email' }
+          }],
+        },
+        {
+          name: 'manufacturer_c',
+          displayName: 'Manufacturer',
+          createdAt: '2016-01-23T00:55:18Z',
+          updatedAt: '2016-01-23T00:55:18Z',
+          idField: 'marketoGUID',
+          dedupeFields: ['name'],
+          searchableFields: [['name'], ['marketoGUID']],
+          relationships: [{
+            field: 'email',
+            type: 'child',
+            relatedTo: { name: 'Lead', field: 'email' }
+          }]
+        }],
+        success: true
+      }
+    end
+
+    context 'with no object names' do
+      before do
+        stub_request(:get, "https://#{host}/rest/v1/customobjects.json")
+          .to_return(json_stub(response_stub))
+      end
+
+      subject { client.get_list_of_custom_objects }
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'with object names' do
+      let(:object_names) { %w(device_c manufacturer_c) }
+
+      before do
+        stub_request(:get, "https://#{host}/rest/v1/customobjects.json")
+          .with(query: {names: object_names.join(',')})
+          .to_return(json_stub(response_stub))
+      end
+
+      subject { client.get_list_of_custom_objects(object_names) }
+
+      it { is_expected.to eq(response_stub) }
+    end
+  end
+
+  describe '#describe_custom_object' do
+    let(:response_stub) do
+      {
+        requestId: "eeef#152858b17d2",
+        result: [{
+          name: "device_c",
+          displayName: "Device",
+          description: "this is a device object",
+          createdAt: "2016-01-23T00:51:18Z",
+          updatedAt: "2016-01-23T00:51:18Z",
+          idField: "marketoGUID",
+          dedupeFields: ["serialNumber"],
+          searchableFields: [["serialNumber"], ["marketoGUID"]],
+          relationships: [{
+            field: "serialNumber",
+            type: "child",
+            relatedTo: {
+              name: "Lead",
+              field: "serialNumber"
+            }
+          }],
+          fields: [{
+            name: "createdAt",
+            displayName: "Created At",
+            dataType: "datetime",
+            updateable: false
+            },
+            { name: "marketoGUID",
+              displayName: "Marketo GUID",
+              dataType: "string",
+              length:36,
+              updateable: false
+            },
+            { name: "updatedAt",
+              displayName: "Updated At",
+              dataType: "datetime",
+              updateable: false
+            },
+            { name: "serialNumber",
+              displayName: "serial number",
+              dataType: "string",
+              length: 255,
+              updateable: true
+            }]
+          }],
+          success: true
+        }
+    end
+
+    before do
+      stub_request(:get, "https://#{host}/rest/v1/customobjects/#{object_name}/describe.json")
+        .to_return(json_stub(response_stub))
+    end
+
+    subject { client.describe_custom_object(object_name) }
+
+    context "when the object name is valid" do
+      let(:object_name) { :device_c }
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context "when the object name is invalid" do
+      let(:object_name) { nil }
+
+      it 'should raise an Error' do
+        object_name = []
+        expect { subject }.to raise_error(Mrkt::Errors::Unknown)
+      end
+    end
+  end
+
+  describe "#createupdate_custom_objects" do
+    let(:object_name) { 'device' }
+
+    let(:devices) do
+      [{
+        serialNumber: 'serial_number_1',
+        description: 'device'
+      }]
+    end
+
+    let(:request_body) do
+      {
+        input: [{
+          serialNumber: 'serial_number_1',
+          description: 'device'
+        }],
+        action: 'createOrUpdate',
+        dedupeBy: 'dedupeFields'
+      }
+    end
+
+    let(:response_stub) do
+      {
+        requestId: 'c245#14cd6830ae2',
+        success: true,
+        result: [{
+          id: 1,
+          status: 'created'
+        }]
+      }
+    end
+
+    subject { client.createupdate_custom_objects(object_name, devices) }
+
+    before do
+      stub_request(:post, "https://#{host}/rest/v1/customobjects/#{object_name}.json")
+        .with(json_stub(request_body))
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe "#delete_custom_objects" do
+    let(:object_name) { 'device' }
+
+    let(:search_fields) do
+      { serialNumber: 'serial_number_1' }
+    end
+
+    let(:request_body) do
+      {
+        input: search_fields,
+        deleteBy: 'dedupeFields'
+      }
+    end
+
+    let(:response_stub) do
+      {
+        requestId: 'c245#14cd6830ae2',
+        success: true,
+        result: [{
+          seq: 0,
+          status: "deleted",
+          marketoGUID: "1fc49d4fcb86"
+        }]
+      }
+    end
+
+    subject { client.delete_custom_objects(object_name, search_fields) }
+
+    before do
+      stub_request(:post, "https://#{host}/rest/v1/customobjects/#{object_name}/delete.json")
+        .with(json_stub(request_body))
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe "#get_custom_objects" do
+    let(:object_name) { 'device'}
+
+    let(:filter_values) do
+      [{
+        serialNumber: 'serial_number_1'
+      }]
+    end
+
+    let(:request_body) do
+      {
+        input: filter_values,
+        filterType: 'dedupeFields'
+      }
+    end
+
+    let(:response_stub) do
+      {
+        requestId: "1490d#1528af5232",
+        result: [{
+          seq: 0,
+          marketoGUID: "163b231LPr23200e570",
+          serialNumber: "serial_number_1",
+          createdAt: "2016-01-23T05:01:01Z",
+          updatedAt: "2016-01-29T00:26:00Z"
+        }],
+        success: true
+      }
+    end
+
+    subject { client.get_custom_objects(object_name, filter_values) }
+
+    before do
+      stub_request(:post, "https://#{host}/rest/v1/customobjects/#{object_name}.json?_method=GET")
+        .with(json_stub(request_body))
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+end

data/spec/concerns/crud_programs_spec.rb

@@ -0,0 +1,88 @@
+describe Mrkt::CrudPrograms do
+  include_context 'initialized client'
+
+  describe '#browse_programs' do
+    let(:response_stub) do
+      {
+        success: true,
+        warnings: [],
+        errors: [],
+        requestId: '7a39#1511bf8a41c',
+        result: [
+          {
+            id: 1035,
+            name: 'clone it',
+            description: '',
+            createdAt: '2015-11-18T15:25:35Z+0000',
+            updatedAt: '2015-11-18T15:25:46Z+0000',
+            url: 'https://app-devlocal1.marketo.com/#NP1035A1',
+            type: 'Engagement',
+            channel: 'Nurture',
+            folder: {
+              type: 'Folder',
+              value: 28,
+              folderName: 'Nurturing'
+            },
+            status: 'on',
+            workspace: 'Default'
+          }
+        ]
+      }
+    end
+
+    subject { client.browse_programs }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/asset/v1/programs.json")
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#get_program_by_id' do
+    let(:response_stub) do
+      {
+        success: true,
+        warnings: [],
+        errors: [],
+        requestId: '948f#14db037ec71',
+        result: [
+          {
+            id: 1107,
+            name: 'AAA2QueryProgramName',
+            description: 'AssetAPI: getProgram tests',
+            createdAt: '2015-05-21T22:45:13Z+0000',
+            updatedAt: '2015-05-21T22:45:13Z+0000',
+            url: 'https://app-devlocal1.marketo.com/#PG1107A1',
+            type: 'Default',
+            channel: 'Online Advertising',
+            folder: {
+              type: 'Folder',
+              value: 1910,
+              folderName: 'ProgramQueryTestFolder'
+            },
+            status: '',
+            workspace: 'Default',
+            tags: [
+              {
+                tagType: 'AAA1 Required Tag Type',
+                tagValue: 'AAA1 RT1'
+              }
+            ],
+            costs: nil
+          }
+        ]
+      }
+    end
+
+    subject { client.get_program_by_id(1107) }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/asset/v1/program/1107.json")
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mrkt
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - KARASZI István
@@ -9,22 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -158,9 +164,11 @@ files:
 - lib/mrkt/concerns/authentication.rb
 - lib/mrkt/concerns/connection.rb
 - lib/mrkt/concerns/crud_campaigns.rb
+- lib/mrkt/concerns/crud_custom_objects.rb
 - lib/mrkt/concerns/crud_helpers.rb
 - lib/mrkt/concerns/crud_leads.rb
 - lib/mrkt/concerns/crud_lists.rb
+- lib/mrkt/concerns/crud_programs.rb
 - lib/mrkt/concerns/import_leads.rb
 - lib/mrkt/errors.rb
 - lib/mrkt/faraday_middleware.rb
@@ -169,8 +177,10 @@ files:
 - mrkt.gemspec
 - spec/concerns/authentication_spec.rb
 - spec/concerns/crud_campaigns_spec.rb
+- spec/concerns/crud_custom_objects_spec.rb
 - spec/concerns/crud_leads_spec.rb
 - spec/concerns/crud_lists_spec.rb
+- spec/concerns/crud_programs_spec.rb
 - spec/concerns/import_leads_spec.rb
 - spec/errors_spec.rb
 - spec/mkto_rest_spec.rb
@@ -197,15 +207,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Marketo REST API Facade
 test_files:
 - spec/concerns/authentication_spec.rb
 - spec/concerns/crud_campaigns_spec.rb
+- spec/concerns/crud_custom_objects_spec.rb
 - spec/concerns/crud_leads_spec.rb
 - spec/concerns/crud_lists_spec.rb
+- spec/concerns/crud_programs_spec.rb
 - spec/concerns/import_leads_spec.rb
 - spec/errors_spec.rb
 - spec/mkto_rest_spec.rb