clever-ruby 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 72240221ff70715106fd5d8c9a1a729e22ac6151
-  data.tar.gz: aa22601ec563ecd02478f61772b788e1d1fd22fb
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTYwZWI0M2M2MzkzNDU4NjI5NTFkZjFhMmFkYTQ1OWViYjcyZjg5Yg==
+  data.tar.gz: !binary |-
+    ZWEwMzk3OWMyYmM0NGE4N2UzMWYyNWVmNTk2YmFiOTA1NzllZGNhNw==
 SHA512:
-  metadata.gz: 748147377f319880ae59d5998bea552e4059cd64e23bf53467b970b533441f2fdb91c90a3f102a5866ea461b90ab98d8bbf5a58db9325ab6185c1d9256b2b4be
-  data.tar.gz: 4afb8665b6a1852a54a581b3370efce8f6b1a9176a761b438cc2e7a650147dbf638e22e1894d1de11ab0f888fcc58321a0322fc2d4a6c1d67f39ec9a3d0ce127
+  metadata.gz: !binary |-
+    MGEzMjk4YzU1YzkzYTY0YjNmNGUwNjdhZWRjMGU5OGE1NDkwOTVkZDYxY2Nh
+    ZjQ5OGZiNGQyN2E4NWZiYTVhZGZhNGVlYzVhM2NkMWFmN2IyN2Q4M2E4Mzll
+    NmM3OTE3NWY4ZWI0NTA1N2U5OTljOGRhM2ZmZThlOWExNDMyOGU=
+  data.tar.gz: !binary |-
+    NGE1MDRmNGNjMzI3YzIxM2Y3MTQ3NTlhYWVjNDJmYzQzNjQxMjA5NWJkZjYz
+    MDhlZjA1OTYyYWUzYTZmYTNlNDljZWNiMGRjNTllNmExYjM1NzgyN2JhZTdi
+    ZTJjYTlhODM0YTY0ODEyZmYyYTJlYTY2MDgwNWQ4MDBiYWZiNWM=

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.10.0 (2014-10-09)
+
+* Add tracking headers to all api requeusts
+
+## 0.9.0 (2014-10-02)
+
+* Update district to accept optional auth token
+
 ## 0.8.0 (2014-09-12)
 
 * Add last method to lists of results for all resources

data/lib/clever-ruby.rb

@@ -6,6 +6,7 @@ require 'open-uri'
 require 'set'
 require 'uri'
 require 'cgi'
+require 'json'
 
 require 'clever-ruby/version'
 
@@ -120,6 +121,29 @@ module Clever
     [url, payload]
   end
 
+  # Headers hash for user-agent tracking
+  # @api private
+  # @return [Hash] headers to add to request
+  def self.tracking_headers
+    {
+      bindings_version: Clever::VERSION,
+      lang: 'ruby',
+      lang_version: RUBY_VERSION.to_s + ' p' + RUBY_PATCHLEVEL.to_s,
+      platform: RUBY_PLATFORM.to_s,
+      publisher: 'clever',
+      uname: uname
+    }
+  end
+
+  # Retrieves system's uname
+  # @api private
+  # @return [String] uname with the system's uname
+  def self.uname
+    `uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i
+  rescue SystemCallError
+    'cannot get uname'
+  end
+
   # Create options hash that specifies an HTTP request from request data
   # @api private
   # @return [Hash] parameters for executing a request
@@ -128,7 +152,9 @@ module Clever
     url = api_url url
     url, payload = create_payload method, url, params
 
-    headers[:Authorization] = 'Bearer ' + Clever.token if Clever.token
+    headers[:authorization] = 'Bearer ' + Clever.token if Clever.token
+    headers[:user_agent] = 'Clever/RubyBindings/' + Clever::VERSION
+    headers[:x_clever_client_user_agent] = tracking_headers.to_json
 
     opts = {
       method: method,

data/lib/clever-ruby/version.rb

@@ -1,5 +1,5 @@
 # Clever Ruby library
 module Clever
   # Version
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/test/unit/clever_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'json'
 
 # basic clever-ruby tests
 # TODO: organize better
@@ -22,4 +23,41 @@ describe Clever do
     query_string = Clever.convert_to_query_string created_at: '2013-02-15T 2:30:42Z'
     query_string.must_equal 'created_at=2013-02-15T%202:30:42Z'
   end
+
+  describe '.create_request_opts' do
+    before do
+      method, url = 'get', 'quotes'
+      params = { education: 'powerful weapon' }
+      headers = { author: 'Nelson Mandela' }
+      @options = Clever.create_request_opts method, url, params, headers
+    end
+    it 'sets method and url' do
+      assert_equal 'get', @options[:method], 'Method not set properly'
+      assert_equal(
+        'https://api.clever.com/quotes?education=powerful%20weapon',
+        @options[:url],
+        'URL not formed properly with params')
+    end
+    it 'adds tracking headers' do
+      headers = @options[:headers]
+      assert headers.key?(:authorization), 'Did not set authorization header'
+      assert_match(/Bearer/, headers[:authorization])
+      assert headers.key?(:user_agent), 'Did not set User Agent header'
+      assert_match %r{Clever/RubyBindings/}, headers[:user_agent]
+      assert(
+        headers.key?(:x_clever_client_user_agent),
+        'Did not set Clever Client User Agent header')
+      assert headers.key?(:author), 'Did not keep original header'
+
+      custom_ua = JSON.parse(headers[:x_clever_client_user_agent], symbolize_names: true)
+      assert custom_ua.key?(:lang), 'Did not set lang in custom user agent header'
+      assert_equal custom_ua[:lang], 'ruby', 'Lang is not set to ruby'
+      assert custom_ua.key?(:lang_version), 'Did not set lang_version in custom user agent header'
+      assert custom_ua.key?(:platform), 'Did not set platform in custom user agent header'
+      assert custom_ua.key?(:uname), 'Did not set uname in custom user agent header'
+      assert custom_ua.key?(:publisher), 'Did not set publisher in custom user agent header'
+      assert_equal custom_ua[:publisher], 'clever', 'Did not set publisher to clever'
+      assert custom_ua.key?(:bindings_version), 'Did not set bindings_version'
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Clever Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-02 00:00:00.000000000 Z
+date: 2014-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -56,14 +56,14 @@ dependencies:
   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
@@ -316,17 +316,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby bindings to the Clever API.
@@ -417,3 +417,4 @@ test_files:
 - test/unit/configuration_test.rb
 - test/unit/event_test.rb
 - test/unit/optional_attributes_test.rb
+has_rdoc: