delighted 1.0.0.beta2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3328aa5e8d5da9e0aa18d14b249638e8fa18fbab
-  data.tar.gz: ed423baff436f425bdbc72a531bd337ae890b84a
+  metadata.gz: fbd30413c6cbb1ddf012ba06c1e4360d14f4713e
+  data.tar.gz: c936317dfc07e80425b559384aeef161c98ea364
 SHA512:
-  metadata.gz: f63f19f6995a497ff70d0cd0265cfaef551cc4617a2640ff88e2803095c0f71b35f1609fc8cb91759920335f61abff8d608ef0d78f3e18bb4f5bb13fb23272a5
-  data.tar.gz: cc0421d791025dfcc08564b5efcc1bc46095790cc7eae3faee3812b9e11a2e34ba66eb85b9e8a0831787535b0f55847070e1f99fcfa63ba0bfcba758bf492517
+  metadata.gz: d2318fd1929ee0e18781c50a98758af693fffa390b39511aa7a6522cb50df751de823d418c541ecd06f09c1a648a1c3aae714aa155a91c028db4bf0289f264ad
+  data.tar.gz: 7980888bf830ed0777ff63d6bc56a7a304caa7a9c2028792ba1c2b2c9edbf06792f7540b99893975d7673f08e901d97058fb298758e58c5f298ba96544a4a89d

data/.travis.yml

@@ -6,6 +6,5 @@ rvm:
   - 1.8.7
   - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
+  - rbx-2.1.1
   - ree

data/README.md

@@ -1,15 +1,16 @@
 # Delighted API client for Ruby [![Build Status](https://travis-ci.org/delighted/delighted-ruby.png)](https://travis-ci.org/delighted/delighted-ruby)
 
-
 Official Ruby client for the [Delighted](https://delightedapp.com) API.
 
-For installation and usage instructions, please [sign in to your Delighted account](https://delightedapp.com/signin) and follow the API documentation under Settings.
+For basic installation and usage instructions, please [sign in to your Delighted account](https://delightedapp.com/signin) and follow the API documentation under Settings.
+
+For more detailed examples, please see [USAGE.md](https://github.com/delighted/delighted-ruby/blob/master/USAGE.md).
 
 ## Supported Rubies
 
 - Ruby MRI (1.8.7+)
 - JRuby (1.8 + 1.9 modes)
-- RBX (1.8 + 1.9 modes)
+- RBX (2.1.1)
 - REE (1.8.7-2012.02)
 
 ## Contributing

data/USAGE.md

@@ -0,0 +1,99 @@
+## Installation
+
+Add `gem 'delighted'` to your application's Gemfile, and then run `bundle` to install.
+
+## Configuration
+
+To get started, you need to configure the client with your secret API key. If you're using Rails, you should add the following to new initializer file in `config/initializers/delighted.rb`.
+
+```ruby
+require 'delighted'
+Delighted.api_key = 'YOUR_API_KEY'
+```
+
+For further options, read the [advanced configuration section](#advanced-configuration).
+
+**Note:** Your API key is secret, and you should treat it like a password. You can find your API key in your Delighted account, under *Settings* > *API*.
+
+## Usage
+
+### Adding/updating people and scheduling surveys
+
+```ruby
+# Add a new person, and schedule a survey immediately
+person1 = Delighted::Person.create(:email => "foo+testing1@delightedapp.com")
+
+# Add a new person, and schedule a survey after 1 minute (60 seconds)
+person2 = Delighted::Person.create(:email => "foo+testing2@delightedapp.com", :delay => 60)
+
+# Add a new person, but do not schedule a survey
+person3 = Delighted::Person.create(:email => "foo+testing3@delightedapp.com", :send => false)
+
+# Add a new person with full set of attributes, including a custom question product name,
+# and schedule a survey 30 seconds
+person4 = Delighted::Person.create(:email => "foo+testing4@delightedapp.com", :name => "Joe Bloggs",
+  :properties => { :customer_id => 123, :country => "USA", :question_product_name => "Apple Genius Bar" },
+  :delay => 30)
+
+# Update an existing person (identified by email), adding a name, without scheduling a survey
+updated_person1 = Delighted::Person.create(:email => "foo+testing1@delightedapp.com",
+  :name => "James Scott", :send => false)
+```
+
+### Adding survey responses
+
+```ruby
+# Add a survey response, score only
+survey_response1 = Delighted::SurveyResponse.create(:person => person1.id, :score => 10)
+
+# Add *another* survey response (for the same person), score and comment
+survey_response2 = Delighted::SurveyResponse.create(:person => person1.id, :score => 5,
+  :comment => "Really nice.")
+```
+
+### Listing survey responses
+
+```ruby
+# List all survey responses, 20 per page
+survey_responses_page_1 = Delighted::SurveyResponse.all
+survey_responses_page_2 = Delighted::SurveyResponse.all(:page => 2)
+
+# List all survey responses, 100 per page, page 5, with a time range
+filtered_survey_responses = Delighted::SurveyResponse.all(:page => 5, :per_page => 100,
+  :since => Time.utc(2013, 10, 01), :until => Time.utc(2013, 11, 01))
+```
+
+### Retrieving metrics
+
+```ruby
+# Get current metrics, 30-day simple moving average, from most recent response
+metrics = Delighted::Metrics.retrieve
+
+# Get metrics, for given range
+metrics = Delighted::Metrics.retrieve(:since => Time.utc(2013, 10, 01),
+  :until => Time.utc(2013, 11, 01))
+```
+
+## <a name="advanced-configuration"></a> Advanced configuration
+
+The following options are configurable for the client:
+
+```ruby
+Delighted.api_key
+Delighted.api_base_url # default: 'https://api.delightedapp.com/v1'
+Delighted.http_adapter # default: Delighted::HTTPAdapter.new
+```
+
+By default, a shared instance of `Delighted::Client` is created lazily in `Delighted.shared_client`. If you want to create your own client, perhaps for testing or if you have multiple API keys, you can:
+
+```ruby
+# Create an custom client instance, and pass as last argument to resource actions
+client = Delighted::Client.new(:api_key => 'API_KEY',
+  :api_base_url => 'https://api.delightedapp.com/v1', :http_adapter => Delighted::HTTPAdapter.new)
+metrics_from_custom_client = Delighted::Metrics.retrieve({}, client)
+
+# Or, you can set Delighted.shared_client yourself
+Delighed.shared_client = Delighted::Client.new(:api_key => 'API_KEY',
+  :api_base_url => 'https://api.delightedapp.com/v1', :http_adapter => Delighted::HTTPAdapter.new)
+metrics_from_custom_shared_client = Delighted::Metrics.retrieve
+```

data/lib/delighted.rb

@@ -5,6 +5,7 @@ require 'multi_json'
 require 'set'
 require 'thread'
 
+require 'delighted/version'
 require 'delighted/utils'
 require 'delighted/json'
 

data/lib/delighted/client.rb

@@ -50,7 +50,8 @@ module Delighted
 
     def default_headers
       @default_headers ||= {
-        'Authorization' => "Basic #{["#{@api_key}:"].pack('m0')}"
+        'Authorization' => "Basic #{["#{@api_key}:"].pack('m0')}",
+        'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}"
       }.freeze
     end
   end

data/lib/delighted/version.rb

@@ -1,3 +1,3 @@
 module Delighted
-  VERSION = "1.0.0.beta2"
+  VERSION = "1.0.0"
 end

data/test/delighted_test.rb

@@ -10,7 +10,7 @@ end
 class Delighted::MetricsTest < Delighted::TestCase
   def test_retrieving_metrics
     uri = URI.parse("https://api.delightedapp.com/v1/metrics")
-    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json" }
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
     response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ :nps => 10 }))
     mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
 
@@ -25,7 +25,7 @@ end
 class Delighted::PeopleTest < Delighted::TestCase
   def test_creating_or_updating_a_person
     uri = URI.parse("https://api.delightedapp.com/v1/people")
-    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'Content-Type' => 'application/json' }
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
     data = Delighted::JSON.dump({ :email => 'foo@bar.com' })
     response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ :id => '123', :email => 'foo@bar.com' }))
     mock_http_adapter.expects(:request).with(:post, uri, headers, data).once.returns(response)
@@ -41,7 +41,7 @@ end
 class Delighted::SurveyResponseTest < Delighted::TestCase
   def test_creating_a_survey_response
     uri = URI.parse("https://api.delightedapp.com/v1/survey_responses")
-    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'Content-Type' => 'application/json' }
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
     data = Delighted::JSON.dump({ :person => '123', :score => 10 })
     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)
@@ -56,7 +56,7 @@ class Delighted::SurveyResponseTest < Delighted::TestCase
 
   def test_listing_all_survey_responses
     uri = URI.parse("https://api.delightedapp.com/v1/survey_responses")
-    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json" }
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
     response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump([{ :id => '123', :comment => 'One' }, { :id => '456', :comment => 'Two' }]))
     mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delighted
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0
 platform: ruby
 authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2013-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -79,6 +79,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- USAGE.md
 - delighted.gemspec
 - lib/delighted.rb
 - lib/delighted/client.rb
@@ -113,12 +114,12 @@ 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.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Delighted is the easiest and most beautiful way to measure customer happiness.