serp_metrics 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+spec/api_credentials.yml
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'rspec'
+gem 'vcr'
+gem 'webmock'
+gem 'timecop'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 SEHabitat. http://sehabitat.com
+
+MIT License
+
+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,25 @@
+# SerpMetrics
+
+Ruby interface to the SERP Metrics API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'serp_metrics'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serp_metrics
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/serp_metrics.rb

@@ -0,0 +1,25 @@
+require 'base64'
+require 'openssl'
+require 'json'
+
+require 'serp_metrics/version'
+require 'serp_metrics/response'
+require 'serp_metrics/command_sets/base'
+require 'serp_metrics/command_sets/account'
+require 'serp_metrics/command_sets/engines'
+require 'serp_metrics/command_sets/flux'
+require 'serp_metrics/command_sets/keywords'
+require 'serp_metrics/command_sets/priorities'
+require 'serp_metrics/commands'
+require 'serp_metrics/client'
+
+module SerpMetrics
+  API_URI = 'http://api.serpmetrics.com'
+  USER_AGENT = 'SERPMetrics Ruby Library'
+
+  class << self
+    def client
+      @client ||= Client.new
+    end
+  end
+end

data/lib/serp_metrics/client.rb

@@ -0,0 +1,34 @@
+module SerpMetrics
+  class Client
+    include SerpMetrics::Commands
+
+    attr_accessor :key, :secret
+
+    def initialize(key = nil, secret = nil)
+      self.key = key
+      self.secret = secret
+    end
+
+    def configure
+      yield self
+      self
+    end
+
+    protected
+
+    def generate_signature(timestamp = nil)
+      Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', secret, timestamp.to_i.to_s))
+    end
+
+    def generate_signature_hash(timestamp = nil)
+      timestamp ||= Time.now.utc
+      signature = generate_signature(timestamp)
+
+      {
+        :key => key,
+        :ts => timestamp.to_i.to_s,
+        :auth => signature
+      }
+    end
+  end
+end

data/lib/serp_metrics/command_sets/account.rb

@@ -0,0 +1,13 @@
+module SerpMetrics
+  module CommandSets
+    class Account < Base
+      def credit
+        transact(:post, '/users/credit')
+      end
+
+      def time
+        transact(:post, '/users/time')
+      end
+    end
+  end
+end

data/lib/serp_metrics/command_sets/base.rb

@@ -0,0 +1,47 @@
+require 'httpclient'
+
+module SerpMetrics
+  module CommandSets
+    class Base
+      attr_accessor :client
+
+      def initialize(client)
+        self.client = client
+      end
+
+      protected
+
+      def transact(method, path, options = {})
+        signature_hash = client.send(:generate_signature_hash)
+
+        query = signature_hash
+        query = query.merge(:params => options.to_json) unless options.empty?
+
+        res = case method
+        when :get
+          HTTPClient.get(SerpMetrics::API_URI + path, {
+            :query => (to_query(query) unless query.empty?)
+          })
+        when :post
+          inner_res = HTTPClient.post(SerpMetrics::API_URI + path, {
+            :body => (to_query(query) unless query.empty?)
+          })
+
+          if inner_res.redirect?
+            inner_res = HTTPClient.get(inner_res.http_header['Location'].first)
+          end
+
+          inner_res
+        end
+
+        JSON.parse(res.body)
+      end
+
+      private
+
+      def to_query(query)
+        URI.encode_www_form(query)
+      end
+    end
+  end
+end

data/lib/serp_metrics/command_sets/engines.rb

@@ -0,0 +1,9 @@
+module SerpMetrics
+  module CommandSets
+    class Engines < Base
+      def codes
+        transact(:post, '/engines/codes')
+      end
+    end
+  end
+end

data/lib/serp_metrics/command_sets/flux.rb

@@ -0,0 +1,13 @@
+module SerpMetrics
+  module CommandSets
+    class Flux < Base
+      def flux(engine_code, type = 'daily')
+        transaction_options = {
+          :engine_code => engine_code,
+          :type => type
+        }
+        transact(:post, '/flux/trend', transaction_options)
+      end
+    end
+  end
+end

data/lib/serp_metrics/command_sets/keywords.rb

@@ -0,0 +1,41 @@
+module SerpMetrics
+  module CommandSets
+    class Keywords < Base
+      def add(keyword, engines)
+        transaction_options = {
+          :keyword => keyword,
+          :engines => engines
+        }
+        transact(:post, '/keywords/add', transaction_options)
+      end
+
+      def remove(keyword_id)
+        transaction_options = {
+          :keyword_id => keyword_id,
+        }
+        transact(:post, '/keywords/delete', transaction_options)
+      end
+
+      def check(keyword_id, engine, limit = 10)
+        transaction_options = {
+          :keyword_id => keyword_id,
+          :engine => engine,
+          :limit => limit
+        }
+        transact(:post, '/keywords/check', transaction_options)
+      end
+
+      def serp(check_id, domain = nil)
+        transaction_options = {
+          :check_id => check_id,
+          :domain => domain
+        }
+        transact(:post, '/keywords/serp', transaction_options)
+      end
+
+      def all
+        transact(:post, '/keywords/all')
+      end
+    end
+  end
+end

data/lib/serp_metrics/command_sets/priorities.rb

@@ -0,0 +1,23 @@
+module SerpMetrics
+  module CommandSets
+    class Priorities < Base
+      def add(keyword, engines, location = nil)
+        transaction_options = {
+          :keyword => keyword,
+          :engines => engines
+        }
+        unless location.nil?
+          transaction_options[:location] = location
+        end
+        transact(:post, '/priority/add', transaction_options)
+      end
+
+      def get(priority_id)
+        transaction_options = {
+          :priority_id => priority_id
+        }
+        transact(:post, '/priority/status', transaction_options)
+      end
+    end
+  end
+end

data/lib/serp_metrics/commands.rb

@@ -0,0 +1,23 @@
+module SerpMetrics
+  module Commands
+    def keywords
+      @keywords ||= SerpMetrics::CommandSets::Keywords.new(self)
+    end
+
+    def account
+      @account ||= SerpMetrics::CommandSets::Account.new(self)
+    end
+
+    def priorities
+      @priorities ||= SerpMetrics::CommandSets::Priorities.new(self)
+    end
+
+    def flux
+      @flux ||= SerpMetrics::CommandSets::Flux.new(self)
+    end
+
+    def engines
+      @engines ||= SerpMetrics::CommandSets::Engines.new(self)
+    end
+  end
+end

data/lib/serp_metrics/response.rb

@@ -0,0 +1,5 @@
+module SerpMetrics
+  class Response
+    attr_accessor :status
+  end
+end

data/lib/serp_metrics/version.rb

@@ -0,0 +1,3 @@
+module SerpMetrics
+  VERSION = '0.0.2'
+end

data/serp_metrics.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serp_metrics/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "serp_metrics"
+  gem.version       = SerpMetrics::VERSION
+  gem.authors       = ["Kristina Lim"]
+  gem.email         = ["kristinalim.ph@gmail.com"]
+  gem.description   = %q{Ruby interface to the SERP Metrics API}
+  gem.summary       = %q{Ruby interface to the SERP Metrics API}
+  gem.homepage      = "https://github.com/wearetribe/serp_metrics.git"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'multi_json', '~> 1.3'
+  gem.add_runtime_dependency 'httpclient', '~> 2.3'
+end

data/spec/api_credentials.yml.sample

@@ -0,0 +1,2 @@
+key: ''
+secret: ''

data/spec/cassettes/serp_metrics__command_sets__account/credit_fetches_credit_information.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.serpmetrics.com/users/credit
+    body:
+      encoding: US-ASCII
+      string: key=h31x%25sd22hgjd2s&ts=1363584772&auth=lROO29qiF4QDoLetbhqb2gKopwnfB%2Bo%2F3g7RGDPcXx8%3D
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 18 Mar 2013 05:35:30 GMT
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '128'
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Set-Cookie:
+      - app=6npjarla1sk78thkood2id09i7; path=/; HttpOnly
+      X-Cache:
+      - OrchestraCache
+      X-Orchestra-Scheme:
+      - http
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":"ok","data":{"api_key":"<SERP_METRICS_KEY>","balance":0,"api_credit":-98.5,"serp_credit":2892},"request_time":1363585088}'
+    http_version: !!null 
+  recorded_at: Mon, 18 Mar 2013 05:32:52 GMT
+recorded_with: VCR 2.4.0

data/spec/cassettes/serp_metrics__command_sets__account/time_fetches_time.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.serpmetrics.com/users/time
+    body:
+      encoding: US-ASCII
+      string: key=h31x%25sd22hgjd2s&ts=1363584772&auth=lROO29qiF4QDoLetbhqb2gKopwnfB%2Bo%2F3g7RGDPcXx8%3D
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 18 Mar 2013 05:35:29 GMT
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '27'
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      X-Cache:
+      - OrchestraCache
+      X-Orchestra-Scheme:
+      - http
+    body:
+      encoding: US-ASCII
+      string: ! '{"request_time":1363585086}'
+    http_version: !!null 
+  recorded_at: Mon, 18 Mar 2013 05:32:52 GMT
+recorded_with: VCR 2.4.0