send_with_us 3.1.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d50c239efd64109971c40b8672b632ca5bfc3919
-  data.tar.gz: bfcf5cb515ac7b97a5c2f0437401970299356b12
+  metadata.gz: 20f559ce008e420040ec7b495e4f47f7a3ae76b2
+  data.tar.gz: 73d4a26a72a2b0d072d6398b5377d63fef7370e6
 SHA512:
-  metadata.gz: aae51ef349b4cf4632ac6cfd6c944e54973eefe6ac982824c40542284c8a92d2fa164a214c425a32d54436dbce5edff2aa4a76c7f6a05ad3f53fb7f4126e286d
-  data.tar.gz: 9c926d10b52714d17a67e946dd3e18e8bf198d854cf2b0ad4128b73aa211b893c5061d6f734dd91c9db80883d136913bc21a554495cae015b6446220c236e12e
+  metadata.gz: 202796e78c60bdf82ecb6c624b5f0148a10f9c46f8e9a83f81e56df709ea97f5fe3b846e585de4dc7134487e14e2532e274b61cca00c93663926363ea9e66fbd
+  data.tar.gz: c19407602ab50efa1600d97580baccd97101af0fdb1bee19c0898149e58390aae5ad2e40dc5118bb76c06f1dc3ba47fd492f26e919be897e1b8d9d7e5541ad6f

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+4.0.1 - Remove unused methods
+4.0.0 - Deprecate Logs List API endpoint
 3.1.0 - Add `strict` option to the render call
 3.0.0 - Deprecate and remove Conversions API calls
 2.0.0 - Deprecate Customer Groups API

data/README.md

@@ -150,7 +150,7 @@ begin
         ],
         files: ['path/to/attachment.txt'],
         esp_account: 'esp_MYESPACCOUNT',
-        version: 'v2',
+        version_name: 'v2',
         tags: ['tag1', 'tag2'],
         locale: 'en-US')
     puts result
@@ -214,6 +214,7 @@ end
 ```
 
 ### Remove Customer from Drip Campaign
+
 ```ruby
 require 'rubygems'
 require 'send_with_us'
@@ -285,23 +286,9 @@ result = obj.customer_create("visha@example.com")
 result = obj.customer_delete("visha@example.com")
 ```
 
-### Get logs for customer
-This will retrieve email logs for a customer.
-
-Optional Arguments:
-- **count** – The number of logs to return. _Max: 100, Default: 100._
-- **created_gt** – Return logs created strictly after the given UTC timestamp.
-- **created_lt** – Return logs created strictly before the given UTC timestamp.
-
-
-```ruby
-obj.customer_email_log('customer@example.com', count: 1)
-```
-
 ## Templates
 
 ```ruby
-
 # List Templates
 obj.list_templates() # Alternatively, obj.emails()
 
@@ -314,12 +301,14 @@ obj.delete_template(template_id)
 # List Template Versions
 obj.list_template_versions(template_id)
 
+# Get Template Version
+obj.get_template_version(template_id, version_id)
+
 # Update Template Version
 obj.update_template_version(template_id, version_id, name, subject, html, text)
 
 # Create Template Version
 obj.create_template_version(template_id, name, subject, html, text)
-
 ```
 
 
@@ -353,16 +342,24 @@ Take a look at our Mailer that you can use similarly to ActionMailer
 
 ## Logs
 
+### Get single log
+
+Used to get the details for a single log. The log ID can be obtained by recording the `receipt_id` value returned from the `send` call.
+
+```ruby
+obj.log('log_sld7xWJ3isc23-3')
+```
+
+### Get logs for customer
+This will retrieve email logs for a customer.
+
 Optional Arguments:
 - **count** – The number of logs to return. _Max: 100, Default: 100._
-- **offset** – Offset the number of logs to return. _Default: 0_
 - **created_gt** – Return logs created strictly after the given UTC timestamp.
-- **created_gte** – Return logs created on or after the given UTC timestamp.
 - **created_lt** – Return logs created strictly before the given UTC timestamp.
-- **created_lte** – Return logs created on or before the given UTC timestamp.
 
 ```ruby
-obj.logs(count: 1, offset: 1)
+obj.customer_email_log('customer@example.com', count: 1)
 ```
 
 ## Errors

data/lib/send_with_us/api.rb

@@ -214,14 +214,6 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}")
     end
 
-    def list_customers_on_campaign(drip_campaign_id)
-      SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}/customers")
-    end
-
-    def list_customers_on_campaign_step(drip_campaign_id, drip_campaign_step_id)
-      SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}/step/#{drip_campaign_step_id}/customers")
-    end
-
     def customer_get(email)
       SendWithUs::ApiRequest.new(@configuration).get("customers/#{email}")
     end
@@ -258,25 +250,6 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).get(endpoint)
     end
 
-    def logs(options = {})
-      endpoint = 'logs'
-      params   = {}
-
-      params[:count]       = options[:count]       unless options[:count].nil?
-      params[:offset]      = options[:offset]      unless options[:offset].nil?
-      params[:created_gt]  = options[:created_gt]  unless options[:created_gt].nil?
-      params[:created_gte] = options[:created_gte] unless options[:created_gte].nil?
-      params[:created_lt]  = options[:created_lt]  unless options[:created_lt].nil?
-      params[:created_lte] = options[:created_lte] unless options[:created_lte].nil?
-
-      unless params.empty?
-        params   = URI.encode_www_form(params)
-        endpoint = endpoint + '?' + params
-      end
-
-      SendWithUs::ApiRequest.new(@configuration).get(endpoint)
-    end
-
     def log(log_id)
       endpoint = "logs/#{log_id}"
 

data/lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '3.1.0'
+  VERSION = '4.0.1'
 end

data/test/lib/send_with_us/api_request_test.rb

@@ -260,12 +260,6 @@ class TestApiRequest < Minitest::Test
     assert_instance_of( Net::HTTPSuccess, @request.get(:'drip_campaigns') )
   end
 
-  def test_get_with_params_for_logs
-    build_objects
-    Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
-    assert_instance_of( Net::HTTPSuccess, @request.get(:'logs', {count: 10}.to_json) )
-  end
-
   def test_start_on_drip_campaign
     build_objects
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
@@ -312,10 +306,4 @@ class TestApiRequest < Minitest::Test
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
     assert_instance_of( Net::HTTPSuccess, @request.delete(:'customers/#{@customer[:email]}'))
   end
-
-  def test_logs_with_options
-    build_objects
-    Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
-    assert_instance_of( Net::HTTPSuccess, @request.get(:'logs?count=2&offset=10'))
-  end
 end

data/test/lib/send_with_us/api_test.rb

@@ -22,21 +22,6 @@ describe SendWithUs::Api do
     it('configs') { SendWithUs::Api.new( api_key: @custom_api_key ).configuration.api_key.must_equal @custom_api_key }
   end
 
-  describe '#logs' do
-    describe 'without options' do
-      let(:options) { nil }
-      before { SendWithUs::ApiRequest.any_instance.expects(:get).with('logs') }
-
-      it { subject.logs }
-    end
-    describe 'with options' do
-      let(:options) { { count: 2 } }
-      before { SendWithUs::ApiRequest.any_instance.expects(:get).with('logs?count=2') }
-
-      it { subject.logs(options) }
-    end
-  end
-
   describe '#customer_email_log' do
     describe 'without options' do
       let(:options) { nil }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: send_with_us
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Matt Harris
@@ -12,48 +12,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: SendWithUs.com Ruby Client
@@ -63,10 +63,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE"
-- ".github/PULL_REQUEST_TEMPLATE"
-- ".gitignore"
-- ".travis.yml"
+- .github/ISSUE_TEMPLATE
+- .github/PULL_REQUEST_TEMPLATE
+- .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -97,17 +97,17 @@ 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.6.11
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: SendWithUs.com Ruby Client