searchmetrics_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95e1db4ed6494627ea79e3375c5d677a7ee83b75
-  data.tar.gz: 075c549b78119777464bd8ede5d80b8f21e3403b
+  metadata.gz: 9b4e23854b017344179dec2d9b4b50352722dba5
+  data.tar.gz: b94fc66dff6c8e53fd7d2322011177dcf2df43f8
 SHA512:
-  metadata.gz: e48c1ac5a902e4d4480df38340464ce622848a07a3c37839de40f72b58218dbad6d6676eabf7d1aebd327db901976412c6c0e3d6b6ea61e3151b719cbf71063c
-  data.tar.gz: c6fe7c04efc8d60e83f9dc20f414c3c86c5c4cdaa8091f5ec9a215e22d91442ecf61faf4e64721e1e730845d7b4d1ea80f1a897181846adb551fe809034b3aaa
+  metadata.gz: 5b76222f390257b3b92bc1adf45fb402a865c6e5ced5e19a27bc6c87c9dca926598225480be4a766f97ba5350b685ecdcf061418388c6dd7a8c6dbf9297f6000
+  data.tar.gz: 4fb68b98114838f0f72b07dedb0caf84dcc064ef627c21ce5299aafdfb27b76c97fa6d70a24d66e748e3391c04e435f006d8d60019c0f3252914c3542992d703

data/.gitignore

@@ -7,3 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+# project, testing specific
+spec/searchmetrics_config.yml

data/.rubocop.yml

@@ -1,2 +1,5 @@
 inherit_gem:
   td_critic: rubocop.yml
+
+RSpec/FilePath:
+  Enabled: False

data/.travis.yml

@@ -14,6 +14,8 @@ matrix:
   allow_failures:
     - rvm: ruby-head
   fast_finish: true
+before_script:
+  - cp spec/searchmetrics_config.yml.example spec/searchmetrics_config.yml
 script:
   - bundle exec rake
   - bundle exec rubocop

data/History.md

@@ -0,0 +1,11 @@
+
+0.2.0 / 2016-02-24
+==================
+
+  * Use API v3 per default
+  * Drop oauth v1 support
+
+0.1.0 / 2015-11-24
+==================
+
+  * Initial version released

data/README.md

@@ -31,7 +31,8 @@ SearchmetricsClient.configure do |config|
 end
 ```
 
-Additionally you can specify `api_version` and `api_url`, which defaults to `v1` and `http://api.searchmetrics.com` regardless.
+Additionally you can specify `api_version` and `api_url`, which defaults to
+`v3` and `http://api.searchmetrics.com` regardless.
 
 ## Usage
 
@@ -57,11 +58,22 @@ response = SearchmetricsClient::Request.send_request_from_hash(
              params: { countrycode: 'DE', keyword: 'ruby' }
            )
 ```
+
 Returned value can be accessed by `#value` method:
 
 ```ruby
 response.value
-# => [{:cpc=>"2.37", :competition=>"3", :search_volume=>"12366", :trend=>"81:100:100:81:81:81:81:66:81:81:81:81", :ad_budget=>"29307.419999999998", :integration=>"images", :advertiser_count=>"0", :keyword=>"ruby", :year_month=>"201510"}]
+```
+
+Response will look like:
+
+```ruby
+[{
+  :cpc=>"2.37", :competition=>"3", :search_volume=>"12366",
+  :trend=>"81:100:100:81:81:81:81:66:81:81:81:81",
+  :ad_budget=>"29307.419999999998", :integration=>"images",
+  :advertiser_count=>"0", :keyword=>"ruby", :year_month=>"201510"
+}]
 ```
 
 `#endpoint` returns requested type:
@@ -73,7 +85,7 @@ response.endpoint # => "ResearchKeywordsGetListKeywordinfo"
 `#url` returns requested url:
 
 ```ruby
-response.url # => "http://api.searchmetrics.com/v1/ResearchKeywordsGetListKeywordinfo.json?countrycode=DE&keyword=ruby"
+response.url # => "http://api.searchmetrics.com/v3/ResearchKeywordsGetListKeywordinfo.json?countrycode=DE&keyword=ruby"
 ```
 
 Access to raw response is available by methods `#header` and `#body`.
@@ -81,15 +93,36 @@ Access to raw response is available by methods `#header` and `#body`.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Testing
+
+First you need to have API key and secret and put them on
+`spec/searchmetrics_config.yml`. You can find an example in
+`spec/searchmetrics_config.yml.example`.
+
+
+```
+bundle exec rspec
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/searchmetrics_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/searchmetrics_client. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/lib/searchmetrics_client.rb

@@ -8,4 +8,6 @@ require 'searchmetrics_client/request'
 require 'searchmetrics_client/response'
 
 module SearchmetricsClient
+  API_DEFAULT_VERSION = 'v3'.freeze
+  API_BASE_URL = 'http://api.searchmetrics.com'.freeze
 end

data/lib/searchmetrics_client/client.rb

@@ -1,25 +1,36 @@
-require 'oauth'
+require 'oauth2'
 require 'singleton'
 require 'forwardable'
 
-module SearchmetricsClient
-  class Client
+module SearchmetricsClient # :nodoc:
+  class Client # :nodoc:
     include Singleton
     extend Forwardable
 
     def_delegators :access_token, :get, :post
 
+    def access_token
+      @access_token ||= access_token_api_v3
+    end
+
     private
 
-    def access_token
-      @access_token ||= generate_access_token
+    def api_url
+      File.join(SearchmetricsClient.configuration.api_base_url,
+                SearchmetricsClient.configuration.api_version)
     end
 
-    def generate_access_token
-      consumer = OAuth::Consumer.new(SearchmetricsClient.configuration.api_key,
-                                     SearchmetricsClient.configuration.api_secret,
-                                     site: SearchmetricsClient.configuration.api_url)
-      OAuth::AccessToken.from_hash(consumer, oauth_token: '', oauth_token_secret: '')
+    # http://api.searchmetrics.com/v3/documentation/start
+    def access_token_api_v3
+      token_url = File.join(api_url, 'token')
+      client = OAuth2::Client.new(
+        SearchmetricsClient.configuration.api_key,
+        SearchmetricsClient.configuration.api_secret,
+        site: SearchmetricsClient.configuration.api_base_url,
+        token_url: token_url,
+        token_method: :post
+      )
+      client.client_credentials.get_token
     end
   end
 end

data/lib/searchmetrics_client/configuration.rb

@@ -1,4 +1,4 @@
-module SearchmetricsClient
+module SearchmetricsClient # :nodoc:
   class << self
     attr_accessor :configuration
   end
@@ -8,12 +8,12 @@ module SearchmetricsClient
     yield(configuration)
   end
 
-  class Configuration
-    attr_accessor :api_key, :api_secret, :api_version, :api_url
+  class Configuration # :nodoc:
+    attr_accessor :api_key, :api_secret, :api_version, :api_base_url
 
     def initialize
-      @api_version = 'v1'
-      @api_url     = 'http://api.searchmetrics.com'
+      @api_version  = SearchmetricsClient::API_DEFAULT_VERSION
+      @api_base_url = SearchmetricsClient::API_BASE_URL
     end
   end
 end

data/lib/searchmetrics_client/errors.rb

@@ -1,19 +1,19 @@
 module SearchmetricsClient
   module Errors
-    class ApiCredentialsNotProvided < StandardError
+    class ApiCredentialsNotProvided < StandardError # :nodoc:
       def message
         'You have to configure SearchmetricsClient first.'
       end
     end
 
-    class ApiRequestError < StandardError
+    class ApiRequestError < StandardError # :nodoc:
       def initialize(msg, response)
         @response = response
         super(msg)
       end
     end
 
-    class WrongMethodError < StandardError
+    class WrongMethodError < StandardError # :nodoc:
       def message
         'Cannot determine HTTP method from endpoint name'
       end

data/lib/searchmetrics_client/query.rb

@@ -1,5 +1,5 @@
 module SearchmetricsClient
-  class Query
+  class Query # :nodoc:
     attr_accessor :query, :endpoint, :params
 
     def self.from_hash(hash)

data/lib/searchmetrics_client/request.rb

@@ -2,7 +2,7 @@ require 'forwardable'
 require 'multi_json'
 
 module SearchmetricsClient
-  class Request
+  class Request # :nodoc:
     attr_reader :url, :query, :response
 
     extend Forwardable
@@ -25,8 +25,9 @@ module SearchmetricsClient
     def send_request
       check_credentials
       result = Client.instance.public_send(method, url)
-      check_errors(result)
       @response = SearchmetricsClient::Response.new(self, result)
+    rescue OAuth2::Error => e
+      check_errors(e.response)
     end
 
     private
@@ -34,29 +35,36 @@ module SearchmetricsClient
     def method
       return :get if endpoint =~ /Get/
       return :post if endpoint =~ /Post/
-      fail SearchmetricsClient::Errors::WrongMethodError
+      raise SearchmetricsClient::Errors::WrongMethodError
     end
 
     def build_url
-      [
-        "#{SearchmetricsClient.configuration.api_url}/",
-        "#{SearchmetricsClient.configuration.api_version}/",
-        query.query
-      ].join
+      File.join(SearchmetricsClient.configuration.api_base_url,
+                SearchmetricsClient.configuration.api_version,
+                query.query)
     end
 
     def check_credentials
-      fail SearchmetricsClient::Errors::ApiCredentialsNotProvided unless credentials_present?
+      unless credentials_present?
+        raise SearchmetricsClient::Errors::ApiCredentialsNotProvided
+      end
     end
 
     def credentials_present?
-      SearchmetricsClient.configuration.api_key && SearchmetricsClient.configuration.api_secret
+      SearchmetricsClient.configuration.api_key &&
+        SearchmetricsClient.configuration.api_secret
+    end
+
+    def result_success?(result)
+      return true if result.status == 200
+      false
     end
 
     def check_errors(result)
-      return if result.code == '200'
-      message = MultiJson.load(result.body, symbolize_keys: true)[:error_message]
-      fail SearchmetricsClient::Errors::ApiRequestError.new(message, result)
+      return if result_success?(result)
+      body = MultiJson.load(result.body, symbolize_keys: true)
+      message = body[:error_message]
+      raise SearchmetricsClient::Errors::ApiRequestError.new(message, result)
     end
   end
 end

data/lib/searchmetrics_client/response.rb

@@ -1,8 +1,8 @@
 require 'forwardable'
 require 'multi_json'
 
-module SearchmetricsClient
-  class Response
+module SearchmetricsClient # :nodoc:
+  class Response # :nodoc:
     attr_reader :request
 
     extend Forwardable
@@ -19,7 +19,7 @@ module SearchmetricsClient
     end
 
     def status
-      @raw_response.code.to_i
+      @raw_response.status
     end
   end
 end

data/lib/searchmetrics_client/version.rb

@@ -1,3 +1,3 @@
 module SearchmetricsClient
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'.freeze
 end

data/searchmetrics_client.gemspec

@@ -10,6 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ['developers@td-berlin.com']
 
   spec.summary       = 'A thin abstraction over the searchmetrics API'
+  spec.description   = 'Client library and thin abstraction over the' \
+    ' searchmetrics API'
   spec.homepage      = 'https://github.com/td-berlin/searchmetrics_client'
   spec.license       = 'MIT'
 
@@ -20,13 +22,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'oauth', '~> 0.4.7'
+  spec.add_dependency 'oauth2', '~> 1.0'
   spec.add_dependency 'multi_json', '~> 1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', '~> 3.4'
   spec.add_development_dependency 'vcr', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 1.22'
-  spec.add_development_dependency 'td_critic', '~> 0.1'
+  spec.add_development_dependency 'td_critic', '~> 0.2'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: searchmetrics_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - TD Developers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: oauth
+  name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -114,15 +114,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-description: 
+        version: '0.2'
+description: Client library and thin abstraction over the searchmetrics API
 email:
 - developers@td-berlin.com
 executables: []
@@ -135,6 +135,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- History.md
 - LICENSE
 - README.md
 - Rakefile