delighted 1.8.0 → 2.0.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17fbb642fdf92f20cf5150c683672f285b346dbc47f2299a16324c05ba916cb1
-  data.tar.gz: 9f01f27d82dfcc7ceb9566aeeb1b54fde0bea5269cfbf06263707b023b39d2d7
+  metadata.gz: 935f134ce42d4fd9df625582e5983ca52097c1025266d1b12bdc0e3a8d1c6a82
+  data.tar.gz: 1c05ac2216de6f94213ba2fd47f5d039af4ad751a342495524af59b162ed7161
 SHA512:
-  metadata.gz: a1fd60896320ae26991069d5f4287b90dfad66954ab049db110c2624c2f771c81b87563faa042d4517a8138235d121eaffa02fae5a0ba08aab88c2d04ebd8e95
-  data.tar.gz: a01145982fbc8b3ce25d5bbc19799f037b66caf84ac1a9b34c0a0dc6beb8eedc43c55edfb9ace154558c638ca9fd94aab5c42ff20887aa5bbd5f6095b154ae6a
+  metadata.gz: a799887d2859ceb0efa8f3fa72be34c3fc25ecca0f681616ecab1a2d5eed711dea5056bd0077676ce6681cf6125f79abcb01c1e09e68c893e3630d703ef09399
+  data.tar.gz: 9f6b6c2d5443e892c75c733f3b7e466d5cfbf21aeef923e0a87d3d5db85c35d744b9a1f8f45deb3fd802a06e27cb0a5bdf693e888535bf77a5e622c453caf356

data/.travis.yml

@@ -1,12 +1,11 @@
 language: ruby
 before_install: gem update bundler
 rvm:
+  - ruby-head
+  - 2.5
   - 2.2
   - 2.1
   - 2.0
   - 1.9.3
-  - 1.9.2
-  - 1.8.7
   - jruby-18mode
   - jruby-19mode
-  - ree

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 2.0.0rc1 (Unreleased)
+
+Features:
+
+- Add `Delighted::Person.list`
+
+Compatibility changes:
+
+- Add support for Ruby 2.7
+- Drop support for Ruby 1.8.7, 1.9.2, and ree
+
 ## 1.8.0 (2018-05-22)
 
 Features:

data/README.md

@@ -49,6 +49,28 @@ updated_person1 = Delighted::Person.create(:email => "foo+test1@delighted.com",
   :name => "James Scott", :send => false)
 ```
 
+Listing all people:
+
+```ruby
+# List all people, auto pagination
+# Note: Make sure to handle the possible rate limits error
+people = Delighted::Person.list
+begin
+  people.auto_paging_each do |person|
+    # Do something with person
+  end
+rescue Delighted::RateLimitError => e
+  # Indicates how long to wait before making this request again
+  e.retry_after
+  retry
+end
+
+# For convenience, this method can use a sleep to automatically handle rate limits
+people.auto_paging_each({ auto_handle_rate_limits: true }) do |person|
+  # Do something with person
+end
+```
+
 Unsubscribing people:
 
 ```ruby
@@ -56,7 +78,7 @@ Unsubscribing people:
 Delighted::Unsubscribe.create(:person_email => "foo+test1@delighted.com")
 ```
 
-Listing people who have unsubscribed:
+Listing people who have unsubscribed (auto pagination not supported):
 
 ```ruby
 # List all people who have unsubscribed, 20 per page, first 2 pages
@@ -64,7 +86,7 @@ survey_responses_page1 = Delighted::Unsubscribe.all
 survey_responses_page2 = Delighted::Unsubscribe.all(:page => 2)
 ```
 
-Listing people whose emails have bounced:
+Listing people whose emails have bounced (auto pagination not supported):
 
 ```ruby
 # List all people whose emails have bounced, 20 per page, first 2 pages

data/lib/delighted.rb

@@ -9,9 +9,11 @@ require 'delighted/version'
 require 'delighted/utils'
 require 'delighted/json'
 
+require 'delighted/list_resource'
 require 'delighted/enumerable_resource_collection'
 require 'delighted/resource'
 require 'delighted/operations/all'
+require 'delighted/operations/list'
 require 'delighted/operations/create'
 require 'delighted/operations/retrieve'
 require 'delighted/operations/update'

data/lib/delighted/client.rb

@@ -2,6 +2,7 @@ module Delighted
   class Client
     DEFAULT_API_BASE_URL = "https://api.delightedapp.com/v1"
     DEFAULT_HTTP_ADAPTER = HTTPAdapter.new
+    DEFAULT_ACCEPT_HEADER = "application/json"
 
     def initialize(opts = {})
       @api_key = opts[:api_key] or raise ArgumentError, "You must provide an API key by setting Delighted.api_key = '123abc' or passing { :api_key => '123abc' } when instantiating Delighted::Client.new"
@@ -10,13 +11,21 @@ module Delighted
     end
 
     def get_json(path, params = {})
-      headers = default_headers.dup.merge('Accept' => 'application/json')
+      request_get(path, {params: params})[:json]
+    end
 
-      uri = URI.parse(File.join(@api_base_url, path))
+    def request_get(path, opts = {})
+      accept_header = opts.fetch(:accept_header, DEFAULT_ACCEPT_HEADER)
+      params = opts.fetch(:params, {})
+
+      headers = default_headers.dup.merge('Accept' => accept_header)
+
+      path = File.join(@api_base_url, path) unless is_full_url(path)
+      uri = URI.parse(path)
       uri.query = Utils.to_query(params) unless params.empty?
 
       response = @http_adapter.request(:get, uri, headers)
-      handle_json_response(response)
+      { json: handle_json_response(response), response: response }
     end
 
     def post_json(path, params = {})
@@ -76,5 +85,9 @@ module Delighted
         'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}"
       }.freeze
     end
+
+    def is_full_url(url)
+      !!(URI::regexp(%w(http https)) =~ url)
+    end
   end
 end

data/lib/delighted/errors.rb

@@ -38,4 +38,8 @@ module Delighted
   class ServiceUnavailableError < Error
     # 503, maintenance or overloaded
   end
+
+  class PaginationError < StandardError
+    # e.g. pagination completed
+  end
 end

data/lib/delighted/http_response.rb

@@ -12,6 +12,11 @@ module Delighted
       get_header_value("content-type")
     end
 
+    def next_link
+      link_header = get_header_value("link")
+      parse_link_header(link_header)[:next]
+    end
+
     def retry_after
       if value = get_header_value("retry-after")
         value.to_i
@@ -37,5 +42,22 @@ module Delighted
         end
       end
     end
+
+    def parse_link_header(header_value)
+      links = {}
+      parts = Array(header_value)
+                .map { |v| v.split(",") }
+                .flatten
+                .map(&:strip)
+      # Parse each part into a named link
+      parts.each do |part|
+        section = part.split(';')
+        next if section.length < 2
+        url = section[0][/<(.*)>/,1]
+        name = section[1][/rel="?([^"]*)"?/,1].to_sym
+        links[name] = url
+      end
+      links
+    end
   end
 end

data/lib/delighted/list_resource.rb

@@ -0,0 +1,45 @@
+module Delighted
+  class ListResource
+    def initialize(klass, path, opts, client)
+      @class = klass
+      @path = path
+      @opts = opts
+      @client = client
+      @iteration_count = 0
+      @done = false
+    end
+
+    def auto_paging_each(opts = {})
+      raise PaginationError, "pagination completed" if @done
+
+      auto_handle_rate_limits = opts.fetch(:auto_handle_rate_limits, false)
+      loop do
+        begin
+          # Get next (or first) page
+          if @iteration_count == 0
+            data = @client.request_get(@path, { params: @opts })
+          else
+            data = @client.request_get(@next_link)
+          end
+        rescue Delighted::RateLimitedError => e
+          if auto_handle_rate_limits
+            sleep e.retry_after
+            retry
+          else
+            raise
+          end
+        end
+
+        @iteration_count += 1
+        @next_link = data[:response].next_link
+
+        data[:json].map do |attributes|
+          yield @class.new(attributes)
+        end
+
+        break if @next_link.nil?
+      end
+      @done = true
+    end
+  end
+end

data/lib/delighted/operations/list.rb

@@ -0,0 +1,15 @@
+module Delighted
+  module Operations
+    module List
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def list(opts = {}, client = Delighted.shared_client)
+          ListResource.new(self, path, Utils.serialize_values(opts), client)
+        end
+      end
+    end
+  end
+end

data/lib/delighted/resources/person.rb

@@ -4,5 +4,6 @@ module Delighted
 
     include Operations::Create
     include Operations::Delete
+    include Operations::List
   end
 end

data/lib/delighted/version.rb

@@ -1,3 +1,3 @@
 module Delighted
-  VERSION = "1.8.0"
+  VERSION = "2.0.0rc1"
 end

data/test/delighted_test.rb

@@ -38,6 +38,129 @@ class Delighted::MetricsTest < Delighted::TestCase
 end
 
 class Delighted::PeopleTest < Delighted::TestCase
+  def test_listing_people_auto_paginate
+    uri = URI.parse("https://api.delightedapp.com/v1/people")
+    uri_next = URI.parse("https://api.delightedapp.com/v1/people.json?page_info=123456789")
+    headers = { "Authorization" => @auth_header, "Accept" => "application/json", "User-Agent" => "Delighted RubyGem #{Delighted::VERSION}" }
+
+    # First request mock
+    example_person1 = {:person_id => "4945", :email => "foo@example.com", :name => "Gold"}
+    example_person2 = {:person_id => "4946", :email => "foo+2@example.com", :name => "Silver"}
+    response = Delighted::HTTPResponse.new(200, {"Link" => "<#{uri_next}>; rel=\"next\""}, Delighted::JSON.dump([example_person1,example_person2]))
+    mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
+
+    # Next request mock
+    example_person_next = {:person_id => "4947", :email => "foo+3@example.com", :name => "Bronze"}
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump([example_person_next]))
+    mock_http_adapter.expects(:request).with(:get, uri_next, headers).once.returns(response)
+
+    persons_all = []
+    Delighted::Person.list.auto_paging_each do |p|
+      persons_all << p
+    end
+
+    assert_equal 3, persons_all.size
+
+    first_person = persons_all[0]
+    assert_kind_of Delighted::Person, first_person
+    assert_equal "Gold", first_person.name
+    assert_equal example_person1, first_person.to_hash
+    second_person = persons_all[1]
+    assert_kind_of Delighted::Person, second_person
+    assert_equal "Silver", second_person.name
+    assert_equal example_person2, second_person.to_hash
+    third_person = persons_all[2]
+    assert_kind_of Delighted::Person, third_person
+    assert_equal "Bronze", third_person.name
+    assert_equal example_person_next, third_person.to_hash
+  end
+
+  def test_listing_people_rate_limited
+    uri = URI.parse("https://api.delightedapp.com/v1/people")
+    uri_next = URI.parse("https://api.delightedapp.com/v1/people.json?page_info=123456789")
+    headers = { "Authorization" => @auth_header, "Accept" => "application/json", "User-Agent" => "Delighted RubyGem #{Delighted::VERSION}" }
+
+    # First request mock
+    example_person1 = {:person_id => "4945", :email => "foo@example.com", :name => "Gold"}
+    response = Delighted::HTTPResponse.new(200, {"Link" => "<#{uri_next}>; rel=\"next\""}, Delighted::JSON.dump([example_person1]))
+    mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
+
+    # Next rate limited request mock
+    response = Delighted::HTTPResponse.new(429, { "Retry-After" => "10" }, {})
+    mock_http_adapter.expects(:request).with(:get, uri_next, headers).once.returns(response)
+
+    persons_all = []
+    exception = assert_raises Delighted::RateLimitedError do
+      Delighted::Person.list.auto_paging_each({ :auto_handle_rate_limits => false }) do |p|
+        persons_all << p
+      end
+    end
+
+    assert_equal 10, exception.retry_after
+
+    assert_equal 1, persons_all.size
+    first_person = persons_all[0]
+    assert_kind_of Delighted::Person, first_person
+    assert_equal "Gold", first_person.name
+    assert_equal example_person1, first_person.to_hash
+  end
+
+  def test_listing_people_auto_handle_rate_limits
+    uri = URI.parse("https://api.delightedapp.com/v1/people")
+    uri_next = URI.parse("https://api.delightedapp.com/v1/people.json?page_info=123456789")
+    headers = { "Authorization" => @auth_header, "Accept" => "application/json", "User-Agent" => "Delighted RubyGem #{Delighted::VERSION}" }
+
+    # First request mock
+    example_person1 = {:person_id => "4945", :email => "foo@example.com", :name => "Gold"}
+    response = Delighted::HTTPResponse.new(200, {"Link" => "<#{uri_next}>; rel=\"next\""}, Delighted::JSON.dump([example_person1]))
+    mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
+
+    # Next rate limited request mock, then accepted request
+    response_rate_limited = Delighted::HTTPResponse.new(429, { "Retry-After" => "3" }, {})
+    example_person_next = {:person_id => "4947", :email => "foo+next@example.com", :name => "Silver"}
+    response_ok = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump([example_person_next]))
+    mock_http_adapter.expects(:request).with(:get, uri_next, headers).twice.returns(response_rate_limited, response_ok)
+
+    persons_all = []
+    people = Delighted::Person.list
+    people.expects(:sleep).with(3)
+    people.auto_paging_each({ :auto_handle_rate_limits => true }) do |p|
+      persons_all << p
+    end
+
+    assert_equal 2, persons_all.size
+    first_person = persons_all[0]
+    assert_kind_of Delighted::Person, first_person
+    assert_equal "Gold", first_person.name
+    assert_equal example_person1, first_person.to_hash
+    next_person = persons_all[1]
+    assert_kind_of Delighted::Person, next_person
+    assert_equal "Silver", next_person.name
+    assert_equal example_person_next, next_person.to_hash
+  end
+
+  def test_listing_people_auto_paginate_second_call
+    uri = URI.parse("https://api.delightedapp.com/v1/people")
+    headers = { "Authorization" => @auth_header, "Accept" => "application/json", "User-Agent" => "Delighted RubyGem #{Delighted::VERSION}" }
+
+    # First request mock
+    example_person1 = {:person_id => "4945", :email => "foo@example.com", :name => "Gold"}
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump([example_person1]))
+    mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
+
+    persons_all = []
+    people = Delighted::Person.list
+    people.auto_paging_each do |p|
+      persons_all << p
+    end
+
+    assert_equal 1, persons_all.size
+
+    assert_raises Delighted::PaginationError do
+      people.auto_paging_each
+    end
+  end
+
   def test_creating_or_updating_a_person
     uri = URI.parse("https://api.delightedapp.com/v1/people")
     headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delighted
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 2.0.0rc1
 platform: ruby
 authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2020-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -88,9 +88,11 @@ files:
 - lib/delighted/http_adapter.rb
 - lib/delighted/http_response.rb
 - lib/delighted/json.rb
+- lib/delighted/list_resource.rb
 - lib/delighted/operations/all.rb
 - lib/delighted/operations/create.rb
 - lib/delighted/operations/delete.rb
+- lib/delighted/operations/list.rb
 - lib/delighted/operations/retrieve.rb
 - lib/delighted/operations/update.rb
 - lib/delighted/resource.rb
@@ -120,12 +122,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Delighted is the fastest and easiest way to gather actionable feedback from