delighted 1.7.0.rc2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e251f1796dba9ffe7b7afcd1ce2ac727d0946ed
-  data.tar.gz: 37c3ff30f9438afba34538fcd2d4887683df35bb
+  metadata.gz: 24e928b7535e1d51f72461238850e824b27b3920
+  data.tar.gz: 86001bae9ecc475902d0ce5f2d4ed1cc15d6f686
 SHA512:
-  metadata.gz: 6097df943896ec66656aa159d0ab3e8470d2d0cc96535abadf113c343f79409e8930e6ef4d5251324dc30afb2957ad58f0cdd643e1edacb8e8b50ddd232441b4
-  data.tar.gz: 4d59aceba9c83852a568e1edc47e28078b330efa4d95f3a506a412ef6b75794722aacb5169e641d339f62d6a6f99fcdf6dbb0cc589b8fdd5a8be23247100b0e2
+  metadata.gz: 1c62db83772abc00c2a6c1524c8a18f998b953ca227d8f521eaf2a3cb10e7457b078eac3d8d8473668e83c646e8f515a32700435fbc7a59edf715585f87e4eb7
+  data.tar.gz: 0cfa475365360aa17f5e7b81c215e07607eed6d10f867ba5269ef840c62aa88ca032944d613d11d7159b224593cbf0e2b67282aa1da5acdcad9621a7a99904fe

data/.travis.yml

@@ -9,5 +9,4 @@ rvm:
   - 1.8.7
   - jruby-18mode
   - jruby-19mode
-  - rbx-2
   - ree

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 1.7.0.rc2 (2017-10-03)
+## 1.7.0 (2017-10-18)
 
 Features:
 
@@ -54,6 +54,6 @@ Features:
 
 Features:
 
-- Add support for cancelling pending survey requests
+- Add support for canceling pending survey requests
 
 ## 1.0.0 (2013-12-13)

data/README.md

@@ -153,6 +153,20 @@ metrics = Delighted::Metrics.retrieve(:since => Time.utc(2013, 10, 01),
   :until => Time.utc(2013, 11, 01))
 ```
 
+## Rate limits
+
+If a request is rate limited, a `Delighted::RateLimitedError` exception is raised. You can rescue that exception to implement exponential backoff or retry strategies. The exception provides a `#retry_after` method to tell you how many seconds you should wait before retrying. For example:
+
+```ruby
+begin
+  metrics = Delighted::Metrics.retrieve
+rescue Delighted::RateLimitedError => e
+  retry_after_seconds = e.retry_after
+  # wait for retry_after_seconds before retrying
+  # add your retry strategy here ...
+end
+```
+
 ## <a name="advanced-configuration"></a> Advanced configuration & testing
 
 The following options are configurable for the client:
@@ -183,7 +197,6 @@ metrics_from_custom_shared_client = Delighted::Metrics.retrieve
 
 - Ruby MRI (1.8.7+)
 - JRuby (1.8 + 1.9 modes)
-- RBX (2.1.1)
 - REE (1.8.7-2012.02)
 
 ## Contributing

data/lib/delighted/version.rb

@@ -1,3 +1,3 @@
 module Delighted
-  VERSION = "1.7.0.rc2"
+  VERSION = "1.7.0"
 end

data/test/delighted_test.rb

@@ -86,7 +86,10 @@ class Delighted::SurveyResponseTest < Delighted::TestCase
   def test_creating_a_survey_response
     uri = URI.parse("https://api.delightedapp.com/v1/survey_responses")
     headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
-    data = Delighted::JSON.dump({ :person => '123', :score => 10 })
+    data = OrderedHash.new
+    data[:person] = '123'
+    data[:score] = 10
+    data = Delighted::JSON.dump(data)
     response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ :id => '456', :person => '123', :score => 10 }))
     mock_http_adapter.expects(:request).with(:post, uri, headers, data).once.returns(response)
 
@@ -131,7 +134,10 @@ class Delighted::SurveyResponseTest < Delighted::TestCase
   def test_updating_a_survey_response
     uri = URI.parse("https://api.delightedapp.com/v1/survey_responses/456")
     headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
-    data = Delighted::JSON.dump({ :person => '123', :score => 10 })
+    data = OrderedHash.new
+    data[:person] = '123'
+    data[:score] = 10
+    data = Delighted::JSON.dump(data)
     response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ :id => '456', :person => '123', :score => 10 }))
     mock_http_adapter.expects(:request).with(:put, uri, headers, data).once.returns(response)
 

data/test/support/ordered_hash.rb

@@ -0,0 +1,192 @@
+# From https://raw.githubusercontent.com/rails/rails/3-0-stable/activesupport/lib/active_support/ordered_hash.rb
+
+begin
+  require 'psych'
+rescue LoadError
+end
+
+require 'yaml'
+
+YAML.add_builtin_type("omap") do |type, val|
+  OrderedHash[val.map(&:to_a).map(&:first)]
+end
+
+# OrderedHash is namespaced to prevent conflicts with other implementations
+class OrderedHash < ::Hash #:nodoc:
+  def to_yaml_type
+    "!tag:yaml.org,2002:omap"
+  end
+
+  def encode_with(coder)
+    coder.represent_seq '!omap', map { |k,v| { k => v } }
+  end
+
+  def to_yaml(opts = {})
+    if YAML.const_defined?(:ENGINE) && !YAML::ENGINE.syck?
+      return super
+    end
+
+    YAML.quick_emit(self, opts) do |out|
+      out.seq(taguri) do |seq|
+        each do |k, v|
+          seq.add(k => v)
+        end
+      end
+    end
+  end
+
+  # Hash is ordered in Ruby 1.9!
+  if RUBY_VERSION < '1.9'
+
+    # In MRI the Hash class is core and written in C. In particular, methods are
+    # programmed with explicit C function calls and polymorphism is not honored.
+    #
+    # For example, []= is crucial in this implementation to maintain the @keys
+    # array but hash.c invokes rb_hash_aset() originally. This prevents method
+    # reuse through inheritance and forces us to reimplement stuff.
+    #
+    # For instance, we cannot use the inherited #merge! because albeit the algorithm
+    # itself would work, our []= is not being called at all by the C code.
+
+    def initialize(*args, &block)
+      super
+      @keys = []
+    end
+
+    def self.[](*args)
+      ordered_hash = new
+
+      if (args.length == 1 && args.first.is_a?(Array))
+        args.first.each do |key_value_pair|
+          next unless (key_value_pair.is_a?(Array))
+          ordered_hash[key_value_pair[0]] = key_value_pair[1]
+        end
+
+        return ordered_hash
+      end
+
+      unless (args.size % 2 == 0)
+        raise ArgumentError.new("odd number of arguments for Hash")
+      end
+
+      args.each_with_index do |val, ind|
+        next if (ind % 2 != 0)
+        ordered_hash[val] = args[ind + 1]
+      end
+
+      ordered_hash
+    end
+
+    def initialize_copy(other)
+      super
+      # make a deep copy of keys
+      @keys = other.keys
+    end
+
+    def []=(key, value)
+      @keys << key if !has_key?(key)
+      super
+    end
+
+    def delete(key)
+      if has_key? key
+        index = @keys.index(key)
+        @keys.delete_at index
+      end
+      super
+    end
+
+    def delete_if
+      super
+      sync_keys!
+      self
+    end
+
+    def reject!
+      super
+      sync_keys!
+      self
+    end
+
+    def reject(&block)
+      dup.reject!(&block)
+    end
+
+    def keys
+      @keys.dup
+    end
+
+    def values
+      @keys.collect { |key| self[key] }
+    end
+
+    def to_hash
+      self
+    end
+
+    def to_a
+      @keys.map { |key| [ key, self[key] ] }
+    end
+
+    def each_key
+      @keys.each { |key| yield key }
+    end
+
+    def each_value
+      @keys.each { |key| yield self[key]}
+    end
+
+    def each
+      @keys.each {|key| yield [key, self[key]]}
+    end
+
+    alias_method :each_pair, :each
+
+    def clear
+      super
+      @keys.clear
+      self
+    end
+
+    def shift
+      k = @keys.first
+      v = delete(k)
+      [k, v]
+    end
+
+    def merge!(other_hash)
+      if block_given?
+        other_hash.each { |k, v| self[k] = key?(k) ? yield(k, self[k], v) : v }
+      else
+        other_hash.each { |k, v| self[k] = v }
+      end
+      self
+    end
+
+    alias_method :update, :merge!
+
+    def merge(other_hash, &block)
+      dup.merge!(other_hash, &block)
+    end
+
+    # When replacing with another hash, the initial order of our keys must come from the other hash -ordered or not.
+    def replace(other)
+      super
+      @keys = other.keys
+      self
+    end
+
+    def invert
+      OrderedHash[self.to_a.map!{|key_value_pair| key_value_pair.reverse}]
+    end
+
+    def inspect
+      "#<OrderedHash #{super}>"
+    end
+
+    private
+      def sync_keys!
+        @keys.delete_if {|k| !has_key?(k)}
+      end
+  end
+end

data/test/test_helper.rb

@@ -1,6 +1,7 @@
 require 'delighted'
 require 'minitest/autorun'
 require 'mocha/setup'
+require 'support/ordered_hash'
 
 class Delighted::TestCase < Minitest::Test
   include Mocha

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delighted
 version: !ruby/object:Gem::Version
-  version: 1.7.0.rc2
+  version: 1.7.0
 platform: ruby
 authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -102,6 +102,7 @@ files:
 - lib/delighted/utils.rb
 - lib/delighted/version.rb
 - test/delighted_test.rb
+- test/support/ordered_hash.rb
 - test/test_helper.rb
 homepage: https://github.com/delighted/delighted-ruby
 licenses:
@@ -118,9 +119,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13
@@ -130,4 +131,5 @@ summary: Delighted is the fastest and easiest way to gather actionable feedback
   your customers.
 test_files:
 - test/delighted_test.rb
+- test/support/ordered_hash.rb
 - test/test_helper.rb