mrkt 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cf51cc511fdf8b5750a92ddff0f35d7dad207eb
-  data.tar.gz: af29cc93b972906bdc74c260bae780ac3aae713b
+  metadata.gz: d12dd686225c6c59e0f4441adb10a1083e772080
+  data.tar.gz: ac0595a8e7e88a52cfcf87ff2cf3fa3967144a80
 SHA512:
-  metadata.gz: eabcdb7980a68d505ca5ec8822a24554ebde7447769403fc40e4671de9395244fdefae4d3bc12f281c595c6de451856592b933f95942d7d0160ca012d1258b08
-  data.tar.gz: fcf10904882d7b12a0391200dd755ab51f563a426a51ce1274beefe246bf9fb5d847e35a55bc5867b396d45271fa0408da7074999aeaa89ca64c3c0b8e6df448
+  metadata.gz: dd7a1923389e9412dc1e82e943627a27e1b214bebc14d75a4f88fe90b1703a22cb7d45104b00409fd69cfff696078b345ecd5f0f415f9cb138049088da130ed2
+  data.tar.gz: 210a3568aa5888b0eced93b20e6a8b3fbfc81465757608546dae933d638e24d603a40412d7260119fb28ff4b3762b511f876d5f96c4c50af875e5356a3e823bd

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+Documentation:
+  Enabled: false
+LineLength:
+  Enabled: true
+  Max: 120
+MethodLength:
+  Max: 20
+IndentHash:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/Gemfile.lock

@@ -1,13 +1,16 @@
 PATH
   remote: .
   specs:
-    mrkt (0.6.0)
+    mrkt (0.6.1)
       faraday_middleware (~> 0.9.1)
 
 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)
@@ -25,6 +28,9 @@ GEM
     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)
@@ -32,6 +38,7 @@ GEM
     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)
@@ -46,6 +53,13 @@ GEM
       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)
@@ -67,5 +81,9 @@ DEPENDENCIES
   pry-byebug (~> 3.1.0)
   rake (~> 10.0)
   rspec (~> 3.2)
+  rubocop (~> 0.32.1)
   simplecov (~> 0.10.0)
   webmock (~> 1.21.0)
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -68,6 +68,20 @@ response[:result].each do |result|
 end
 ```
 
+### Run a smart campaign on existing leads
+```ruby
+campaign_id = 42        # this is the ID of the campaign
+lead_ids    = [1, 2, 4] # these are the leads who receive the campaign
+tokens      = [{        # these tokens (optional) are then passed to the campaign
+                 name:  '{{my.message}}',
+                 value: 'Updated message'
+               }, {
+                 name:  '{{my.other token}}',
+                 value: 'Value for other token'
+               }]
+client.request_campaign(campaign_id, lead_ids, tokens) # tokens can be omited
+=> { requestId: 'e42b#14272d07d78', success: true }
+```
 
 ## Run Tests
 

data/lib/mrkt.rb

@@ -3,14 +3,20 @@ require 'mrkt/errors'
 
 require 'mrkt/concerns/connection'
 require 'mrkt/concerns/authentication'
+require 'mrkt/concerns/crud_helpers'
+require 'mrkt/concerns/crud_campaigns'
 require 'mrkt/concerns/crud_leads'
+require 'mrkt/concerns/crud_lists'
 require 'mrkt/concerns/import_leads'
 
 module Mrkt
   class Client
     include Connection
     include Authentication
+    include CrudHelpers
+    include CrudCampaigns
     include CrudLeads
+    include CrudLists
     include ImportLeads
 
     attr_accessor :debug

data/lib/mrkt/concerns/crud_campaigns.rb

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

data/lib/mrkt/concerns/crud_helpers.rb

@@ -0,0 +1,12 @@
+module Mrkt
+  module CrudHelpers
+    def map_lead_ids(lead_ids)
+      lead_ids.map { |id| { id: id } }
+    end
+
+    def json_payload(req, payload)
+      req.headers[:content_type] = 'application/json'
+      req.body = JSON.generate(payload)
+    end
+  end
+end

data/lib/mrkt/concerns/crud_leads.rb

@@ -12,7 +12,7 @@ module Mrkt
       get('/rest/v1/leads.json', params)
     end
 
-    def createupdate_leads(leads, action: 'createOrUpdate', lookup_field: nil, partition_name: nil)
+    def createupdate_leads(leads, action: 'createOrUpdate', lookup_field: nil, partition_name: nil, async_processing: nil)
       post('/rest/v1/leads.json') do |req|
         params = {
           action: action,
@@ -20,6 +20,7 @@ module Mrkt
         }
         params[:lookupField] = lookup_field if lookup_field
         params[:partitionName] = partition_name if partition_name
+        params[:asyncProcessing] = async_processing if async_processing
 
         json_payload(req, params)
       end
@@ -27,15 +28,10 @@ module Mrkt
 
     def delete_leads(leads)
       delete('/rest/v1/leads.json') do |req|
-        json_payload(req, input: leads.map { |lead_id| { id: lead_id } })
+        json_payload(req, input: map_lead_ids(leads))
       end
     end
 
-    def json_payload(req, payload)
-      req.headers[:content_type] = 'application/json'
-      req.body = JSON.generate(payload)
-    end
-
     def associate_lead(id, cookie)
       params = Faraday::Utils::ParamsHash.new
       params[:cookie] = cookie

data/lib/mrkt/concerns/crud_lists.rb

@@ -0,0 +1,22 @@
+module Mrkt
+  module CrudLists
+    def get_leads_by_list(list_id, fields: nil, batch_size: nil, next_page_token: nil)
+      params = {}
+      params[:fields] = fields if fields
+      params[:batchSize] = batch_size if batch_size
+      params[:nextPageToken] = next_page_token if next_page_token
+
+      get("/rest/v1/list/#{list_id}/leads.json", params)
+    end
+
+    def add_leads_to_list(list_id, lead_ids)
+      post("/rest/v1/lists/#{list_id}/leads.json") do |req|
+        params = {
+          input: map_lead_ids(lead_ids)
+        }
+
+        json_payload(req, params)
+      end
+    end
+  end
+end

data/lib/mrkt/version.rb

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

data/mrkt.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/raszi/mrkt'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($RS)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w(lib)
@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0.10.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.1.0'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.7'
+  spec.add_development_dependency 'rubocop', '~> 0.32.1'
 end

data/spec/concerns/crud_campaigns_spec.rb

@@ -0,0 +1,71 @@
+describe Mrkt::CrudCampaigns do
+  include_context 'initialized client'
+
+  describe '#request_campaign' do
+    let(:id) { 42 }
+    let(:lead_ids) { [1234, 5678] }
+    let(:tokens) do
+      [{
+         name:  '{{my.message}}',
+         value: 'Updated message'
+       }, {
+         name:  '{{my.other token}}',
+         value: 'Value for other token'
+       }]
+    end
+    subject { client.request_campaign(id, lead_ids, tokens) }
+
+    before do
+      stub_request(:post, "https://#{host}/rest/v1/campaigns/#{id}/trigger.json")
+        .with(body: { input: { leads: lead_ids.map { |id| { id: id } }, tokens: tokens } })
+        .to_return(json_stub(response_stub))
+    end
+
+    context 'with an invalid campaign id' do
+      let(:response_stub) do
+        {
+          requestId: 'a9b#14eb6771358',
+          success:   false,
+          errors:    [{
+                        code:    '1013',
+                        message: 'Campaign not found'
+                      }]
+        }
+      end
+
+      it 'should raise an Error' do
+        expect { subject }.to raise_error(Mrkt::Errors::ObjectNotFound)
+      end
+    end
+
+    context 'with valid campaign id' do
+      context 'with invalid lead id' do
+        let(:response_stub) do
+          {
+            requestId: '7cdc#14eb6ae8a86',
+            success:   false,
+            errors:    [{
+                          code:    '1004',
+                          message: 'Lead [1234] not found'
+                        }]
+          }
+        end
+
+        it 'should raise an Error' do
+          expect { subject }.to raise_error(Mrkt::Errors::LeadNotFound)
+        end
+      end
+
+      context 'for valid lead ids' do
+        let(:response_stub) do
+          {
+            requestId: 'e42b#14272d07d78',
+            success:   true
+          }
+        end
+
+        it { is_expected.to eq(response_stub) }
+      end
+    end
+  end
+end

data/spec/concerns/crud_leads_spec.rb

@@ -136,7 +136,7 @@ describe Mrkt::CrudLeads do
           success: false,
           errors: [
             {
-              code: "1004",
+              code: '1004',
               message: "Lead '1' not found"
             }
           ]

data/spec/concerns/crud_lists_spec.rb

@@ -0,0 +1,66 @@
+describe Mrkt::CrudLists do
+  include_context 'initialized client'
+
+  describe '#get_leads_by_list' do
+    let(:list_id) { '1001' }
+    let(:response_stub) do
+      {
+        requestId: 'ab12#12d6ab65024',
+        result: [
+          {
+            id: 1,
+            firstName: nil,
+            lastName: nil,
+            email: 'sample@example.com',
+            updatedAt: '2015-05-19 13:50:57',
+            createdAt: '2015-05-19 13:50:57'
+          }
+        ],
+        success: true
+      }
+    end
+
+    subject { client.get_leads_by_list(list_id) }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/v1/list/#{list_id}/leads.json")
+        .with(query: {})
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#add_leads_to_list' do
+    let(:list_id) { '1001' }
+    let(:lead_ids) { ['1'] }
+    let(:request_body) do
+      {
+        input: [
+          { id: '1' }
+        ]
+      }
+    end
+    let(:response_stub) do
+      {
+        requestId: '16d3f#14d6da7449f',
+        result: [
+          {
+            id: 1,
+            status: 'added'
+          }
+        ],
+        success: true
+      }
+    end
+    subject { client.add_leads_to_list(list_id, lead_ids) }
+
+    before do
+      stub_request(:post, "https://#{host}/rest/v1/lists/#{list_id}/leads.json")
+        .with(json_stub(request_body))
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+end

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@ if ENV['COVERAGE']
 end
 
 if ENV['CODECLIMATE_REPO_TOKEN']
-  require "codeclimate-test-reporter"
+  require 'codeclimate-test-reporter'
   CodeClimate::TestReporter.start
 end
 

data/spec/support/webmock.rb

@@ -10,7 +10,7 @@ RSpec.configure do |config|
 
   if ENV['CODECLIMATE_REPO_TOKEN']
     config.after(:suite) do
-      WebMock.disable_net_connect!(allow: 'codeclimate.com') 
+      WebMock.disable_net_connect!(allow: 'codeclimate.com')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mrkt
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - KARASZI István
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -123,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.7
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.1
 description: This gem helps you to use the Marketo REST API
 email:
 - github@spam.raszi.hu
@@ -133,6 +147,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -142,7 +157,10 @@ files:
 - lib/mrkt.rb
 - lib/mrkt/concerns/authentication.rb
 - lib/mrkt/concerns/connection.rb
+- lib/mrkt/concerns/crud_campaigns.rb
+- lib/mrkt/concerns/crud_helpers.rb
 - lib/mrkt/concerns/crud_leads.rb
+- lib/mrkt/concerns/crud_lists.rb
 - lib/mrkt/concerns/import_leads.rb
 - lib/mrkt/errors.rb
 - lib/mrkt/faraday_middleware.rb
@@ -150,7 +168,9 @@ files:
 - lib/mrkt/version.rb
 - mrkt.gemspec
 - spec/concerns/authentication_spec.rb
+- spec/concerns/crud_campaigns_spec.rb
 - spec/concerns/crud_leads_spec.rb
+- spec/concerns/crud_lists_spec.rb
 - spec/concerns/import_leads_spec.rb
 - spec/errors_spec.rb
 - spec/mkto_rest_spec.rb
@@ -177,13 +197,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 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_leads_spec.rb
+- spec/concerns/crud_lists_spec.rb
 - spec/concerns/import_leads_spec.rb
 - spec/errors_spec.rb
 - spec/mkto_rest_spec.rb