marketingcloudsdk 1.0.0

data/spec/rest_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+describe MarketingCloudSDK::Rest do
+  let(:client) { MarketingCloudSDK::Client.new }
+
+  subject { client }
+  it { should respond_to(:rest_get) }
+  it { should respond_to(:rest_client) }
+  it { should respond_to(:complete_url) }
+
+  describe '#complete_url' do
+    it 'raises an exception when identities are missing' do
+      expect { client.complete_url "some_url/%{parent}/%{child}", {parent: 1} }.to raise_exception 'key{child} not found to complete some_url/%{parent}/%{child}'
+    end
+
+    it 'returns url with all identities replaced' do
+      expect( client.complete_url "some_url/%{parent}/%{child}", {:parent => 1, :child => 2} ).to eq 'some_url/1/2'
+    end
+
+    it 'handles identities with string keys' do
+      expect( client.complete_url "some_url/%{parent}/%{child}", {'parent'=> 1, 'child'=> 2} ).to eq 'some_url/1/2'
+    end
+
+    it 'treats empty values as optional keys' do
+      expect( client.complete_url "some_url/%{parent}/%{child}", {'parent'=> 1, 'child'=> ''} ).to eq 'some_url/1'
+    end
+
+    it 'handles extra keys' do
+      expect( client.complete_url "some_url/%{parent}/%{child}", {'parent'=> 1, 'child'=> '', 'other' => 1} ).to eq 'some_url/1'
+    end
+  end
+
+  describe '#get_url_properties' do
+    it 'returns hash of properties in format string' do
+      expect( client.get_url_properties "some_url/%{parent}/%{child}", {'parent'=> 1, 'child'=> '', 'other' => 1} ).to eq({'parent' => 1, 'child' => ''})
+    end
+
+    it 'handles missing url properties' do
+      expect( client.get_url_properties "some_url/%{parent}/%{child}", {'parent'=> 1, 'other' => 1} ).to eq({'parent' => 1})
+    end
+
+    it 'filters url properties from properties leaving query params' do
+      properties = {'parent'=> 1, 'other' => 1}
+      client.get_url_properties "some_url/%{parent}/%{child}", properties
+      expect(properties).to eq 'other' => 1
+    end
+  end
+
+end

data/spec/soap_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+describe MarketingCloudSDK::Soap do
+
+  let(:client) { MarketingCloudSDK::Client.new }
+
+  subject { client }
+
+  it { should respond_to(:soap_get) }
+  it { should respond_to(:soap_post) }
+  it { should respond_to(:soap_patch) }
+  it { should respond_to(:soap_delete) }
+  it { should respond_to(:soap_describe) }
+
+  it { should respond_to(:header) }
+  it { should_not respond_to(:header=) }
+
+  it { should respond_to(:wsdl) }
+  it { should respond_to(:wsdl=) }
+
+  it { should respond_to(:endpoint) }
+  it { should_not respond_to(:endpoint=) }
+
+  it { should respond_to(:soap_client) }
+  
+  it { should respond_to(:package_name) }
+  it { should respond_to(:package_name=) }
+  
+  it { should respond_to(:package_folders) }
+  it { should respond_to(:package_folders=) }
+
+  its(:debug) { should be_false }
+  its(:wsdl) { should eq 'https://webservice.exacttarget.com/etframework.wsdl' }
+
+  describe '#header' do
+    it 'raises an exception when internal_token is missing' do
+      expect { client.header }.to raise_exception 'Require legacy token for soap header'
+    end
+
+    it 'returns header hash' do
+      client.internal_token = 'innerspace'
+      expect(client.header).to eq(
+        {
+          'oAuth' => { 'oAuthToken' => 'innerspace' },
+          :attributes! => {
+            'oAuth' => { 'xmlns' => 'http://exacttarget.com' }
+          }
+        }
+      )
+    end
+  end
+
+  describe 'requests' do
+    subject {
+      client.stub(:soap_request) do |action, message|
+        [action, message]
+      end
+      client
+    }
+
+    it '#soap_describe calls client with :describe and DescribeRequests message' do
+      expect(subject.soap_describe 'Subscriber').to eq([:describe,
+        {'DescribeRequests' => {'ObjectDefinitionRequest' => {'ObjectType' => 'Subscriber' }}}])
+    end
+
+    describe '#soap_post' do
+      subject {
+        client.stub(:soap_request) do |action, message|
+          [action, message]
+        end
+
+        client.stub_chain(:soap_describe,:editable)
+          .and_return(['First Name', 'Last Name', 'Gender'])
+        client
+      }
+      it 'formats soap :create message for single object' do
+        expect(subject.soap_post 'Subscriber', 'EmailAddress' => 'test@fuelsdk.com' ).to eq([:create,
+          {
+            'Objects' => [{'EmailAddress' => 'test@fuelsdk.com'}],
+            :attributes! => {'Objects' => {'xsi:type' => ('tns:Subscriber')}}
+          }])
+      end
+
+      it 'formats soap :create message for multiple objects' do
+        expect(subject.soap_post 'Subscriber', [{'EmailAddress' => 'first@fuelsdk.com'}, {'EmailAddress' => 'second@fuelsdk.com'}] ).to eq([:create,
+          {
+            'Objects' => [{'EmailAddress' => 'first@fuelsdk.com'}, {'EmailAddress' => 'second@fuelsdk.com'}],
+            :attributes! => {'Objects' => {'xsi:type' => ('tns:Subscriber')}}
+          }])
+      end
+
+      it 'formats soap :create message for single object with an attribute' do
+        expect(subject.soap_post 'Subscriber', {'EmailAddress' => 'test@fuelsdk.com', 'Attributes'=> [{'Name'=>'First Name', 'Value'=>'first'}]}).to eq([:create,
+          {
+            'Objects' => [{
+              'EmailAddress' => 'test@fuelsdk.com',
+              'Attributes' => [{'Name' => 'First Name', 'Value' => 'first'}],
+            }],
+            :attributes! => {'Objects' => {'xsi:type' => ('tns:Subscriber')}}
+          }])
+      end
+
+      it 'formats soap :create message for single object with multiple attributes' do
+        expect(subject.soap_post 'Subscriber', {'EmailAddress' => 'test@fuelsdk.com',
+          'Attributes'=> [{'Name'=>'First Name', 'Value'=>'first'}, {'Name'=>'Last Name', 'Value'=>'subscriber'}]}).to eq([:create,
+          {
+            'Objects' => [{
+              'EmailAddress' => 'test@fuelsdk.com',
+              'Attributes' => [
+                {'Name' => 'First Name', 'Value' => 'first'},
+                {'Name' => 'Last Name', 'Value' => 'subscriber'},
+              ],
+            }],
+            :attributes! => {'Objects' => {'xsi:type' => ('tns:Subscriber')}}
+          }])
+      end
+
+      it 'formats soap :create message for multiple objects with multiple attributes' do
+        expect(subject.soap_post 'Subscriber', [{'EmailAddress' => 'first@fuelsdk.com', 'Attributes'=> [{'Name'=>'First Name', 'Value'=>'first'}, {'Name'=>'Last Name', 'Value'=>'subscriber'}]},
+          {'EmailAddress' => 'second@fuelsdk.com', 'Attributes'=> [{'Name'=>'First Name', 'Value'=>'second'}, {'Name'=>'Last Name', 'Value'=>'subscriber'}]}]).to eq([:create,
+          {
+            'Objects' => [
+              {'EmailAddress' => 'first@fuelsdk.com',
+                'Attributes' => [
+                  {'Name' => 'First Name', 'Value' => 'first'},
+                  {'Name' => 'Last Name', 'Value' => 'subscriber'},
+                ]
+              },
+              {'EmailAddress' => 'second@fuelsdk.com',
+                'Attributes' => [
+                  {'Name' => 'First Name', 'Value' => 'second'},
+                  {'Name' => 'Last Name', 'Value' => 'subscriber'},
+                ]
+              }],
+            :attributes! => {'Objects' => {'xsi:type' => ('tns:Subscriber')}}
+          }])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'marketingcloudsdk'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use the specified formatter
+  config.formatter = :documentation
+end

data/spec/targeting_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe MarketingCloudSDK::Targeting do
+
+  subject { Class.new.new.extend(MarketingCloudSDK::Targeting) }
+
+  it { should respond_to(:endpoint) }
+  it { should_not respond_to(:endpoint=) }
+  it { should respond_to(:determine_stack) }
+  it { should respond_to(:get) }
+  it { should respond_to(:post) }
+  it { should respond_to(:patch) }
+  it { should respond_to(:delete) }
+  it { should respond_to(:access_token) }
+
+  describe '#determine_stack' do
+    let(:client) { c = Class.new.new.extend(MarketingCloudSDK::Targeting)
+      c.stub(:access_token).and_return('open_sesame')
+      c.stub(:get)
+        .with('https://www.exacttargetapis.com/platform/v1/endpoints/soap',{'params'=>{'access_token'=>'open_sesame'}})
+        .and_return({'url' => 'S#.authentication.target'})
+      c
+    }
+    it 'sets @endpoint' do
+      expect(client.send(:determine_stack)).to eq 'S#.authentication.target'
+    end
+  end
+
+  describe '#endpoint' do
+    let(:client) { c = Class.new.new.extend(MarketingCloudSDK::Targeting)
+      c.stub(:get).and_return({'url' => 'S#.authentication.target'})
+      c
+    }
+
+    it 'calls determine_stack to find target' do
+      expect(client.endpoint).to eq 'S#.authentication.target'
+    end
+  end
+end

metadata

@@ -0,0 +1,260 @@
+--- !ruby/object:Gem::Specification
+name: marketingcloudsdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ashok Magar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: API wrapper for SOAP and REST API with Salesforce Marketing Cloud (ExactTarget)
+email:
+- amagar@salesforce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/marketingcloudsdk.rb
+- lib/marketingcloudsdk/client.rb
+- lib/marketingcloudsdk/http_request.rb
+- lib/marketingcloudsdk/objects.rb
+- lib/marketingcloudsdk/rest.rb
+- lib/marketingcloudsdk/soap.rb
+- lib/marketingcloudsdk/targeting.rb
+- lib/marketingcloudsdk/utils.rb
+- lib/marketingcloudsdk/version.rb
+- lib/new.rb
+- marketingcloudsdk.gemspec
+- samples/sample-AddSubscriberToList.rb
+- samples/sample-CreateAndStartDataExtensionImport.rb
+- samples/sample-CreateAndStartListImport.rb
+- samples/sample-CreateContentAreas.rb
+- samples/sample-CreateDataExtensions.rb
+- samples/sample-CreateProfileAttributes.rb
+- samples/sample-SendEmailToDataExtension.rb
+- samples/sample-SendEmailToList.rb
+- samples/sample-SendTriggeredSends.rb
+- samples/sample-bounceevent.rb
+- samples/sample-campaign.rb
+- samples/sample-clickevent.rb
+- samples/sample-contentarea.rb
+- samples/sample-dataextension.rb
+- samples/sample-directverb.rb
+- samples/sample-email.rb
+- samples/sample-email.senddefinition.rb
+- samples/sample-folder.rb
+- samples/sample-import.rb
+- samples/sample-list.rb
+- samples/sample-list.subscriber.rb
+- samples/sample-openevent.rb
+- samples/sample-profileattribute.rb
+- samples/sample-sentevent.rb
+- samples/sample-subscriber.rb
+- samples/sample-triggeredsend.rb
+- samples/sample-unsubevent.rb
+- samples/sample_helper.rb.template
+- spec/client_spec.rb
+- spec/helper_funcs_spec.rb
+- spec/http_request_spec.rb
+- spec/objects_helper_spec.rb
+- spec/objects_spec.rb
+- spec/rest_spec.rb
+- spec/soap_spec.rb
+- spec/spec_helper.rb
+- spec/targeting_spec.rb
+homepage: https://github.com/ExactTarget/FuelSDK-Ruby
+licenses:
+- ''
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Fuel Client Library for Ruby
+test_files:
+- samples/sample-AddSubscriberToList.rb
+- samples/sample-CreateAndStartDataExtensionImport.rb
+- samples/sample-CreateAndStartListImport.rb
+- samples/sample-CreateContentAreas.rb
+- samples/sample-CreateDataExtensions.rb
+- samples/sample-CreateProfileAttributes.rb
+- samples/sample-SendEmailToDataExtension.rb
+- samples/sample-SendEmailToList.rb
+- samples/sample-SendTriggeredSends.rb
+- samples/sample-bounceevent.rb
+- samples/sample-campaign.rb
+- samples/sample-clickevent.rb
+- samples/sample-contentarea.rb
+- samples/sample-dataextension.rb
+- samples/sample-directverb.rb
+- samples/sample-email.rb
+- samples/sample-email.senddefinition.rb
+- samples/sample-folder.rb
+- samples/sample-import.rb
+- samples/sample-list.rb
+- samples/sample-list.subscriber.rb
+- samples/sample-openevent.rb
+- samples/sample-profileattribute.rb
+- samples/sample-sentevent.rb
+- samples/sample-subscriber.rb
+- samples/sample-triggeredsend.rb
+- samples/sample-unsubevent.rb
+- samples/sample_helper.rb.template
+- spec/client_spec.rb
+- spec/helper_funcs_spec.rb
+- spec/http_request_spec.rb
+- spec/objects_helper_spec.rb
+- spec/objects_spec.rb
+- spec/rest_spec.rb
+- spec/soap_spec.rb
+- spec/spec_helper.rb
+- spec/targeting_spec.rb