emarsys 0.3.13 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 438c871d801d4782d2e87ed2fc095847b5323a64
-  data.tar.gz: 9d01a343ecb897f827d3b0e543fb08382e73d540
+SHA256:
+  metadata.gz: b91da527fa70b69756d7dca70b153ec103be4c52ed2fc189b6d8eb6d4036637a
+  data.tar.gz: 1ac969e7acf008b6cc07ae032d3c8ce42b8cdcf398b61bb3b51db0ff14c18533
 SHA512:
-  metadata.gz: c1b1ae69f75b6d77168dee74a56166942266084119f7ba169b3eecf7726bfdd6ef1d4e810195b014bcf3564d6a97f3e1bb1e254638abf0545d54f9ee4e0d7844
-  data.tar.gz: f846c1d9637cf3050fca1b249df4023f1ea6e2f766cec60eb3c46f8ddb9b53b41c91ca47df081d9fa2f4f0f6384c52152b8d11402c5859808d879da38b5cea52
+  metadata.gz: b512d98dc2a1acbb56a1e783fb00a6e3d915d58a66ea1c773b9c92ea444b4724734e004273ee72758b16179b10b304656a07ad56bd5bd406606fe0d9726c02a0
+  data.tar.gz: 955e9a9626883406b3e029929475dbf04971f3411b5c2112626f7faacd0796c7a0216caf9f1548587d686d4d5e54b1a3c29870fc5a376f7f94ef65673c04eb42

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 sudo: false
-cache:
-  bundler: true
+before_install:
+    - gem install bundler
 rvm:
-- jruby-9.0.5.0
-- 2.2.2
+- jruby-9.2.11.0
 - 2.3.1
+- 2.5.8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.4.0
+
+* Add supported segment endpoints and remove the deprecated one ([#64]https://github.com/Absolventa/emarsys-rb/pull/64)
+
 ## v0.3.13 
 
 * Add method to delete ContactList by ID ([#63](https://github.com/Absolventa/emarsys-rb/pull/63))

data/README.md

@@ -161,6 +161,9 @@ Emarsys::ContactList.create
 
 # Delete a contact list
 Emarsys::ContactList.delete(123)
+
+# List all contacts in a contact list
+Emarsys::ContactList.contacts(123)
 ```
 
 #### Emails
@@ -235,8 +238,13 @@ Emarsys::Segment.collection
 ```
 
 ```ruby
-# List contacts in a segment
-Emarsys::Segment.contacts(123, limit: 2000)
+# Run a segment for multiple contacts
+Emarsys::Segment.run(123)
+```
+
+```ruby
+# Check the status of a segment run
+Emarsys::Segment.status('foo123')
 ```
 
 #### Source

data/emarsys.gemspec

@@ -17,12 +17,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.3'
 
   spec.add_dependency "rest-client"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", ">= 3.5.0"
-  spec.add_development_dependency "webmock", "< 2.0"
+  spec.add_development_dependency "webmock", "~> 2.3.2"
   spec.add_development_dependency "timecop"
 end

data/lib/emarsys/data_objects/contact_list.rb

@@ -16,6 +16,14 @@ module Emarsys
         get account, 'contactlist', {}
       end
 
+      # List contacts in a contact list
+      # Reference: https://dev.emarsys.com/v2/contact-lists/list-contacts-in-a-contact-list
+      # 
+      # @param id [Integer] The contact list id
+      def contacts(id, account: nil)
+        get account, "contactlist/#{id}/", {}
+      end
+
       # Create a new contact list
       #
       # @param params [Hash] Contact list information to create

data/lib/emarsys/data_objects/segment.rb

@@ -16,17 +16,22 @@ module Emarsys
         get account, 'filter', {}
       end
 
-      # List ids of contacts in a segment.
-      # Raises Emarsys::SegmentIsEvaluated if the segment is being currently evaluated.
-      # Reference: https://dev.emarsys.com/v2/response-codes/http-202-errors
-      # The `limit` param is required by this endpoint although it is marked as optional in the API v2 doc.
+      # Run a Segment for Multiple Contacts
+      # Reference: https://dev.emarsys.com/v2/segments/run-a-contact-segment-batch
       #
       # @param id [Integer] the id of the segment
-      # @param limit [Integer] the maximum number of records to return
-      # @param offset [Integer] optional offset value for pagination
-      def contacts(id, limit:, offset: 0, account: nil)
-        path = "filter/#{id}/contacts"
-        get account, path, limit: limit, offset: offset
+      def run(id, account: nil)
+        path = "filter/#{id}/runs"
+        post account, path, {}
+      end
+
+      # Poll the Status of a Segment Run for Multiple Contacts
+      # Reference: https://dev.emarsys.com/v2/segments/poll-the-status-of-a-segment-run-for-multiple-contacts
+      #
+      # @param run_id [String] the id of the segment run, @see #run
+      def status(run_id, account: nil)
+        path = "filter/runs/#{run_id}"
+        get account, path, {}
       end
     end
   end

data/lib/emarsys/error.rb

@@ -28,10 +28,6 @@ module Emarsys
   # Raised when Emarsys returns a 500 HTTP status code
   class InternalServerError < Error; end
 
-  # Raised when Emarsys returns a 202 HTTP status code with 10001 Reply Code
-  # https://dev.emarsys.com/v2/response-codes/http-202-errors
-  class SegmentIsEvaluated < Error; end
-
   class AccountNotConfigured < StandardError; end
 
   class AccountRequired < StandardError; end

data/lib/emarsys/response.rb

@@ -21,8 +21,6 @@ module Emarsys
           raise Emarsys::Unauthorized.new(code, text, status)
         elsif status == 429
           raise Emarsys::TooManyRequests.new(code, text, status)
-        elsif status == 202 && code == 10001
-          raise Emarsys::SegmentIsEvaluated.new(code, text, status) 
         else
           raise Emarsys::BadRequest.new(code, text, status)
         end

data/lib/emarsys/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Emarsys
-  VERSION = "0.3.13"
+  VERSION = "0.4.0"
 end

data/spec/emarsys/data_objects/contact_list_spec.rb

@@ -8,4 +8,11 @@ describe Emarsys::ContactList do
       ).to have_been_requested.once
     end
   end
+  describe ".contacts" do
+    it "requests all contacts in the given contact list" do
+      expect(
+        stub_get("contactlist/123/") { Emarsys::ContactList.contacts(123) }
+      ).to have_been_requested.once
+    end
+  end
 end

data/spec/emarsys/data_objects/segment_spec.rb

@@ -7,11 +7,18 @@ describe Emarsys::Segment do
         stub_get("filter") { Emarsys::Segment.collection }
       ).to have_been_requested.once
     end
-    describe ".contacts" do
-      it "requests contact data for a given segment" do
-        stub = stub_request(:get, "https://api.emarsys.net/api/v2/filter/123/contacts/?limit=2000&offset=0").to_return(standard_return_body)
-        Emarsys::Segment.contacts(123, limit: 2000)
-        expect(stub).to have_been_requested.once
+    describe ".run" do
+      it "requests a run for a segment for multiple contacts" do
+        expect(
+          stub_post("filter/123/runs") { Emarsys::Segment.run(123) }
+        ).to have_been_requested.once
+      end
+    end
+    describe ".status" do
+      it "requests the status of the given segment run" do
+        expect(
+          stub_get("filter/runs/foo-333-bar") { Emarsys::Segment.status('foo-333-bar') }
+        ).to have_been_requested.once
       end
     end
   end

data/spec/emarsys/response_spec.rb

@@ -78,14 +78,6 @@ describe Emarsys::Response do
       allow(fake_response).to receive(:code).and_return(429)
       expect{response}.to raise_error(Emarsys::TooManyRequests)
     end
-
-    context 'with Reply Code 10001' do
-      let(:reply_code) { 10001 }
-      it "raises SegmentIsEvaluated error if http-status i 202" do
-        allow(fake_response).to receive(:code).and_return(202)
-        expect{response}.to raise_error(Emarsys::SegmentIsEvaluated)
-      end
-    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emarsys
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel Schoppmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.3.2
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -177,15 +177,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Easy to use ruby library for Emarsys Marketing Suite.