searchmetrics_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95e1db4ed6494627ea79e3375c5d677a7ee83b75
+  data.tar.gz: 075c549b78119777464bd8ede5d80b8f21e3403b
+SHA512:
+  metadata.gz: e48c1ac5a902e4d4480df38340464ce622848a07a3c37839de40f72b58218dbad6d6676eabf7d1aebd327db901976412c6c0e3d6b6ea61e3151b719cbf71063c
+  data.tar.gz: c6fe7c04efc8d60e83f9dc20f414c3c86c5c4cdaa8091f5ec9a215e22d91442ecf61faf4e64721e1e730845d7b4d1ea80f1a897181846adb551fe809034b3aaa

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  td_critic: rubocop.yml

data/.travis.yml

@@ -0,0 +1,19 @@
+sudo: false
+bundler_args: --jobs=3 --retry=3
+cache:
+  - bundler
+before_install:
+  - gem update --remote bundler
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - jruby
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+script:
+  - bundle exec rake
+  - bundle exec rubocop

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in searchmetrics_client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 trommsdorff + drüner gmbh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,95 @@
+# SearchmetricsClient
+
+[![Build Status](https://travis-ci.org/td-berlin/searchmetrics_client.svg)](https://travis-ci.org/td-berlin/searchmetrics_client)
+
+A thin abstraction over the [searchmetrics API](http://api.searchmetrics.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'searchmetrics_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install searchmetrics_client
+
+## Configuration
+
+To start using gem you have to configure API keys as bellow:
+
+```ruby
+SearchmetricsClient.configure do |config|
+  config.api_key    = 'Your api key'
+  config.api_secret = 'Your api secret'
+end
+```
+
+Additionally you can specify `api_version` and `api_url`, which defaults to `v1` and `http://api.searchmetrics.com` regardless.
+
+## Usage
+
+To get metric from Searchmetrics server use:
+
+```ruby
+SearchmetricsClient::Request.send_request_from_hash(
+  endpoint: 'ResearchKeywordsGetListKeywordinfo',
+  params: { countrycode: 'PL',
+            keyword: 'ruby' }
+)
+```
+
+Key `endpoint` is required.
+
+`SearchmetricsClient::Response` object will be returned.
+
+Exemplary call:
+
+```ruby
+response = SearchmetricsClient::Request.send_request_from_hash(
+             endpoint: 'ResearchKeywordsGetListKeywordinfo',
+             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"}]
+```
+
+`#endpoint` returns requested type:
+
+```ruby
+response.endpoint # => "ResearchKeywordsGetListKeywordinfo"
+```
+
+`#url` returns requested url:
+
+```ruby
+response.url # => "http://api.searchmetrics.com/v1/ResearchKeywordsGetListKeywordinfo.json?countrycode=DE&keyword=ruby"
+```
+
+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.
+
+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).
+
+## 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'searchmetrics_client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/searchmetrics_client/client.rb

@@ -0,0 +1,25 @@
+require 'oauth'
+require 'singleton'
+require 'forwardable'
+
+module SearchmetricsClient
+  class Client
+    include Singleton
+    extend Forwardable
+
+    def_delegators :access_token, :get, :post
+
+    private
+
+    def access_token
+      @access_token ||= generate_access_token
+    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: '')
+    end
+  end
+end

data/lib/searchmetrics_client/configuration.rb

@@ -0,0 +1,19 @@
+module SearchmetricsClient
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :api_key, :api_secret, :api_version, :api_url
+
+    def initialize
+      @api_version = 'v1'
+      @api_url     = 'http://api.searchmetrics.com'
+    end
+  end
+end

data/lib/searchmetrics_client/errors.rb

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

data/lib/searchmetrics_client/query.rb

@@ -0,0 +1,38 @@
+module SearchmetricsClient
+  class Query
+    attr_accessor :query, :endpoint, :params
+
+    def self.from_hash(hash)
+      endpoint = hash.fetch(:endpoint)
+      params   = hash.fetch(:params, {})
+      new(endpoint, params)
+    end
+
+    def initialize(endpoint, params = {})
+      @endpoint = endpoint
+      @params   = params
+      @query    = build_query
+    end
+
+    def to_h
+      hash = { endpoint: endpoint }
+      hash[:params] = params unless params.empty?
+      hash
+    end
+
+    private
+
+    def build_query
+      params_string = build_params unless params.empty?
+      "#{endpoint}.json#{params_string}"
+    end
+
+    def build_params
+      params_string = params.map do |k, v|
+        v = v.map(&:to_s).join(',') if v.is_a? Array
+        "#{k}=#{v}"
+      end.join('&')
+      "?#{params_string}"
+    end
+  end
+end

data/lib/searchmetrics_client/request.rb

@@ -0,0 +1,62 @@
+require 'forwardable'
+require 'multi_json'
+
+module SearchmetricsClient
+  class Request
+    attr_reader :url, :query, :response
+
+    extend Forwardable
+    def_delegator :query, :endpoint
+
+    def self.send_request(query)
+      new(query).send_request
+    end
+
+    def self.send_request_from_hash(hash)
+      query = SearchmetricsClient::Query.from_hash(hash)
+      SearchmetricsClient::Request.send_request(query)
+    end
+
+    def initialize(query)
+      @query = query
+      @url = build_url
+    end
+
+    def send_request
+      check_credentials
+      result = Client.instance.public_send(method, url)
+      check_errors(result)
+      @response = SearchmetricsClient::Response.new(self, result)
+    end
+
+    private
+
+    def method
+      return :get if endpoint =~ /Get/
+      return :post if endpoint =~ /Post/
+      fail SearchmetricsClient::Errors::WrongMethodError
+    end
+
+    def build_url
+      [
+        "#{SearchmetricsClient.configuration.api_url}/",
+        "#{SearchmetricsClient.configuration.api_version}/",
+        query.query
+      ].join
+    end
+
+    def check_credentials
+      fail SearchmetricsClient::Errors::ApiCredentialsNotProvided unless credentials_present?
+    end
+
+    def credentials_present?
+      SearchmetricsClient.configuration.api_key && SearchmetricsClient.configuration.api_secret
+    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)
+    end
+  end
+end

data/lib/searchmetrics_client/response.rb

@@ -0,0 +1,25 @@
+require 'forwardable'
+require 'multi_json'
+
+module SearchmetricsClient
+  class Response
+    attr_reader :request
+
+    extend Forwardable
+    def_delegators :request, :endpoint, :query, :url
+    def_delegators :@raw_response, :body, :header
+
+    def initialize(request, raw_response)
+      @request = request
+      @raw_response = raw_response
+    end
+
+    def value
+      @value ||= MultiJson.load(body, symbolize_keys: true)
+    end
+
+    def status
+      @raw_response.code.to_i
+    end
+  end
+end

data/lib/searchmetrics_client/version.rb

@@ -0,0 +1,3 @@
+module SearchmetricsClient
+  VERSION = '0.1.0'
+end

data/lib/searchmetrics_client.rb

@@ -0,0 +1,11 @@
+require 'searchmetrics_client/version'
+
+require 'searchmetrics_client/client'
+require 'searchmetrics_client/configuration'
+require 'searchmetrics_client/errors'
+require 'searchmetrics_client/query'
+require 'searchmetrics_client/request'
+require 'searchmetrics_client/response'
+
+module SearchmetricsClient
+end

data/searchmetrics_client.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'searchmetrics_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'searchmetrics_client'
+  spec.version       = SearchmetricsClient::VERSION
+  spec.authors       = ['TD Developers']
+  spec.email         = ['developers@td-berlin.com']
+
+  spec.summary       = 'A thin abstraction over the searchmetrics API'
+  spec.homepage      = 'https://github.com/td-berlin/searchmetrics_client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  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 '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 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 1.22'
+  spec.add_development_dependency 'td_critic', '~> 0.1'
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: searchmetrics_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TD Developers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: td_critic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: 
+email:
+- developers@td-berlin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/searchmetrics_client.rb
+- lib/searchmetrics_client/client.rb
+- lib/searchmetrics_client/configuration.rb
+- lib/searchmetrics_client/errors.rb
+- lib/searchmetrics_client/query.rb
+- lib/searchmetrics_client/request.rb
+- lib/searchmetrics_client/response.rb
+- lib/searchmetrics_client/version.rb
+- searchmetrics_client.gemspec
+homepage: https://github.com/td-berlin/searchmetrics_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A thin abstraction over the searchmetrics API
+test_files: []