spyfu 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d165dba4f35f660a02dba1a7a79ce992915e26c
-  data.tar.gz: e91bcfc5217810c0a97eb4c5d80a1b3bcead2002
+  metadata.gz: 5f5468bed9e0b0f35e1fbc09f2da59ee9d5d4baf
+  data.tar.gz: 8a457d1cea2074b0e6513405cb6a18f9bcf709fb
 SHA512:
-  metadata.gz: 69b427836a276edac24c8ea9b0851ded4737e77b8807ada04c76a9ed63df3ddac5989c3d304d82f0bd13d87cbd12b3cb6774a0a2b9638cae145ffe4ca0ef2c18
-  data.tar.gz: 3c432be117e0ca70f6fc38dcab68640641d30ef131769cd653ec2647093c512e1dbb3b0951477db182ad4c51136db5a461149b11e8b8a957e13c4a2441d62e8e
+  metadata.gz: e1d7c2ffc1d8f2fca570f5a0c66afbd06ae9ac154539f2f255c9e05f8ec73f823be91011f4745b1a8c4a7721c1c8338a987403b95db6ad80c15b818fe891186d
+  data.tar.gz: e33c415760ccacdde1dbcde97c38f097d50b105f904b0b42a3d204fa7040a9700f178d62071edc5de807dd0e1877292c6600d90f9d9a02f23b0e4a8d04fa0e93

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Robert Graff
+
+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,109 @@
+# spyfu-rb
+
+An unofficial gem to access the [SpyFu API](https://www.spyfu.com/api). It requires [a SpyFu account](https://www.spyfu.com/api/get-started).
+
+# Making a request
+
+Here is a simple example on how to make a request to the API. A full listing of available params on available on [official site](https://www.spyfu.com/api). 
+
+```ruby
+spyfu = SpyFu.client('1234-12345-12345-1234', 'YOURSECRETKEY')
+result = spyfu.kss_api.get_term_page_keywords(:q => 'spyfu api', :r => 100)
+result.body # API returns a JSON object with results
+```
+
+# Getting Started
+
+Get started by `gem install spyfu` or in your Gemfile:
+
+```ruby
+gem 'spyfu'
+```
+
+# API
+
+## Ad History API
+
+You can access the [Core API](https://www.spyfu.com/api/docs/core).
+
+```ruby
+spyfu.ad_history_api.domain_ad_history(...)
+spyfu.ad_history_api.domain_ad_history_with_metrics(...)
+spyfu.ad_history_api.term_ad_history(...)
+```
+
+## Core API
+
+You can access the [Core API](https://www.spyfu.com/api/docs/core).
+
+```ruby
+spyfu.core_api.get_domain_metrics_us(...)
+spyfu.core_api.get_domain_metrics_uk(...)
+spyfu.core_api.get_domain_budget_history_us(...)
+spyfu.core_api.get_domain_budget_history_uk(...)
+spyfu.core_api.get_domain_competitors_us(...)
+spyfu.core_api.get_domain_competitors_uk(...)
+```
+
+## KSS API
+
+You can access the [Keyword SmartSearch API](https://www.spyfu.com/api/docs/related-keywords).
+
+```ruby
+spyfu.kss_api.related_keywords(:q => 'spyfu api', :r => 100)
+spyfu.kss_api.domain_related_keywords(:q => 'spyfu api', :r => 100)
+```
+
+## Leads API
+
+You can access the [Leads API](https://www.spyfu.com/api/docs/leads).
+
+```ruby
+spyfu.leads_api.get_contact_card(...)
+spyfu.leads_api.get_grid(...)
+spyfu.leads_api.get_top_list(...)
+```
+
+## URL API
+
+You can access the [URL API](https://www.spyfu.com/api/docs/url).
+
+```ruby
+spyfu.url_api.organic_kws(:q => "http://resources.spyfu.com/blog/", :r => 100)
+spyfu.url_api.paid_kws(:q => "http://resources.spyfu.com/blog/", :r => 100)
+spyfu.url_api.paid_estimates(...)
+spyfu.url_api.organic_estimates(...)
+```
+
+## Weekly Tracking API
+
+You can access the [Weekly Tracking API](https://www.spyfu.com/api/docs/weekly-tracking).
+
+```ruby
+spyfu.weekly_tracking_api.add_terms(...)
+spyfu.weekly_tracking_api.get_groups(...)
+spyfu.weekly_tracking_api.get_terms(...)
+spyfu.weekly_tracking_api.get_term_data(...)
+spyfu.weekly_tracking_api.delete_terms(...)
+```
+
+# Known Issues
+
+* Parameter values are not properly encoded. Doing so break the request signature.
+* Multiple parameters with the same name and different values are not handled. I don't see where this is used but comments in SpyFu's sample code mentions it.
+* Allow paramers to be more ruby like (:maxRows becomes :max_rows)
+
+
+# Contributing to spyfu-rb
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+# Copyright
+
+Copyright (c) 2014 Robert Graff. See LICENSE.txt for further details.

data/lib/spyfu/api/ad_history.rb

@@ -0,0 +1,24 @@
+module SpyFu
+  module Api
+    class AdHistory < Base
+      # More information: https://www.spyfu.com/apis/ad_history_api/domain_ad_history
+      BASE_ENDPOINT = 'ad_history_api'
+
+      # Get ad history by domain
+      def domain_ad_history(params)
+        send_get "domain_ad_history", params
+      end
+
+      # Get ad history by domain with metrics
+      def domain_ad_history_with_metrics(params)
+        send_get "domain_ad_history_with_metrics", params
+      end
+
+      # Get ad history by domain by Term
+      def term_ad_history(params)
+        send_get "term_ad_history", params
+      end
+
+    end
+  end
+end

data/lib/spyfu/api/base.rb

@@ -0,0 +1,16 @@
+module SpyFu
+  module Api
+    class Base
+      attr :client
+      
+      def initialize(client)
+        @client = client
+      end
+
+      def send_get path, params
+      	SpyFu::Request.new('GET', "#{self.class::BASE_ENDPOINT}/#{path}", params, nil, client.app_id, client.secret_key).request
+      end
+
+    end
+  end
+end

data/lib/spyfu/api/core.rb

@@ -0,0 +1,39 @@
+module SpyFu
+  module Api
+    class Core < Base
+      # More information: https://www.spyfu.com/api/docs/core
+      BASE_ENDPOINT = 'core_api'
+
+      # Get US metrics from domain
+      def get_domain_metrics_us(params)
+        send_get "get_domain_metrics_us", params
+      end
+      
+      # Get UK metrics from domain
+      def get_domain_metrics_uk(params)
+        send_get "get_domain_metrics_uk", params
+      end
+      
+      # Get history of US domain's budget
+      def get_domain_budget_history_us(params)
+        send_get "get_domain_budget_history_us", params
+      end
+      
+      # Get history of UK domain's budget
+      def get_domain_budget_history_uk(params)
+        send_get "get_domain_budget_history_uk", params
+      end
+      
+      # Get US competitors from domain
+      def get_domain_competitors_us(params)
+        send_get "get_domain_competitors_us", params
+      end
+      
+      # Get UK competitors from domain
+      def get_domain_competitors_uk(params)
+        send_get "get_domain_competitors_uk", params
+      end
+
+    end
+  end
+end

data/lib/spyfu/api/kss.rb

@@ -0,0 +1,29 @@
+module SpyFu
+  module Api
+    class Kss < Base
+      # More information: https://www.spyfu.com/apis/ad_history_api/domain_ad_history
+      BASE_ENDPOINT = 'kss_api'
+
+      # Get list of related keywords
+      def related_keywords(params)
+        send_get "kss_kws", params
+      end
+
+      # Get list of domains related to keyword
+      def domain_related_keywords(params)
+        send_get "kss_domains", params
+      end
+
+      # Backward compatibility
+      def get_term_page_keywords(params)
+      	params[:q] = params[:keyword]
+        if !params[:maxRows].nil?
+          params[:r] = params[:maxRows] 
+          params.delete(:maxRows)
+        end
+        related_keywords(params)
+      end
+
+    end
+  end
+end

data/lib/spyfu/api/leads.rb

@@ -0,0 +1,24 @@
+module SpyFu
+  module Api
+    class Leads < Base
+      # More information: https://www.spyfu.com/api/docs/leads
+      BASE_ENDPOINT = 'leads_api'
+
+      # Get list of contacts for a domain
+      def get_contact_card(params)
+        send_get "get_contact_card", params
+      end
+
+      # Get list of contact leads
+      def get_grid(params)
+        send_get "get_grid", params
+      end
+
+      # Get list of contacts for a domain
+      def get_top_list(params)
+        send_get "get_top_list", params
+      end
+
+    end
+  end
+end

data/lib/spyfu/api/url.rb

@@ -0,0 +1,51 @@
+module SpyFu
+  module Api
+    class Url < Base
+      # More information: https://www.spyfu.com/api/docs/url
+      BASE_ENDPOINT = 'url_api'
+
+      # Get paid data from url
+      def paid_kws(params)
+        # Adjust params for backward compatibility
+        if !params[:bgdsv].nil?
+          params[:egdsv] = params[:bgdsv] 
+          params.delete(:bgdsv)
+        end
+
+        if !params[:bldsv].nil?
+          params[:eldsv] = params[:bldsv]
+          params.delete(:bldsv)
+        end
+
+        send_get "paid_kws", params
+      end
+
+      # Get organic data from url
+      def organic_kws(params)
+        # Adjust params for backward compatibility
+        if !params[:blmsv].nil?
+          params[:elmsv] = params[:blmsv] 
+          params.delete(:blmsv)
+        end
+
+        if !params[:bgmsv].nil?
+          params[:egmsv] = params[:bgmsv]
+          params.delete(:bgmsv)
+        end
+        
+        send_get "organic_kws", params
+      end
+
+      # Get paid estimates from url
+      def paid_estimates(params)
+        send_get "paid_estimates", params
+      end
+
+      # Get organic estimates from url
+      def organic_estimates(params)
+        send_get "organic_estimates", params
+      end
+
+    end
+  end
+end

data/lib/spyfu/api/weekly_tracking.rb

@@ -0,0 +1,49 @@
+module SpyFu
+  module Api
+    class WeeklyTracking < Base
+      # More information: https://www.spyfu.com/apis/WeeklyTracking_Api/get_groups
+      BASE_ENDPOINT = 'weeklytracking_api'
+    
+      # Add terms to group
+      def add_terms(params)
+        send_get "add_terms", params
+      end
+
+      # Get list of groups by name
+      def get_groups(params)
+        send_get "get_groups", params
+      end
+
+      # Get list of groups by domain
+      def get_groups_by_domain(params)
+        send_get "get_groups_by_domain", params
+      end
+
+      # Get list of terms by list ID
+      def get_terms(params)
+        send_get "get_terms", params
+      end
+
+      # Get term metrics
+      def get_term_data(params)
+        send_get "get_term_data", params
+      end
+
+      # Delete term from group
+      def delete_term(params)
+        send_get "delete_term", params
+      end
+
+      # Delete group list
+      def delete_group(params)
+        send_get "delete_group", params
+      end
+
+      # Backward compatibility
+      def delete_terms(params)
+        delete_term(params)
+      end
+
+    end
+  end
+end

data/lib/spyfu/client.rb

@@ -0,0 +1,34 @@
+module SpyFu
+  class Client
+    attr :app_id, :secret_key
+
+    def initialize(app_id, secret_key)
+      @app_id = app_id
+      @secret_key = secret_key
+    end
+
+    def ad_history_api
+      SpyFu::Api::AdHistory.new(self)
+    end
+
+    def core_api
+      SpyFu::Api::Core.new(self)
+    end
+
+    def kss_api
+      SpyFu::Api::Kss.new(self)
+    end
+
+    def leads_api
+      SpyFu::Api::Leads.new(self)
+    end
+
+    def url_api
+      SpyFu::Api::Url.new(self)
+    end
+
+    def weekly_tracking_api
+      SpyFu::Api::WeeklyTracking.new(self)
+    end
+  end
+end

data/lib/spyfu/request.rb

@@ -0,0 +1,73 @@
+require 'openssl'
+require 'base64'
+require 'net/http'
+require 'time'
+
+module SpyFu
+  class Request
+    attr :http_method, :params, :post_data, :app_id, :secret_key, :url
+
+    HTTP_HEADER_AUTHENTICATION = "Authentication"
+    HTTP_HEADER_TIMESTAMP = "Timestamp"
+    URL_API_BASE = "https://www.spyfu.com/apis/"
+
+    def initialize(http_method, endpoint, params, post_data, app_id, secret_key)
+      @http_method = http_method
+      @url = URL_API_BASE+endpoint
+      @params = params
+      @post_data = post_data
+      @app_id = app_id
+      @secret_key = secret_key
+    end
+
+    def request
+        req = Net::HTTP::Get.new(uri.request_uri)
+
+        # add authentiation goodness to request object
+        req[HTTP_HEADER_TIMESTAMP] = timestamp
+        req[HTTP_HEADER_AUTHENTICATION] = app_id + ":" + signature
+
+        request = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => true) {|http|
+          http.request(req)
+        }
+        return request
+    end
+
+    def uri
+      @uri ||= URI(url+query_string)
+    end
+
+    def query_string
+      return '' if params.empty?
+      return '?'+params.map { |x| "#{x[0]}=#{x[1]}" }.join("&")
+    end
+
+    def timestamp
+      @timestamp ||= Time.now.getutc.strftime "%A, %B %d, %Y %I:%M:%S %p"
+    end
+
+    def message
+      @message ||= [http_method, timestamp, uri.path, parameter_message].join("\n")
+    end
+
+    def signature
+      digest = OpenSSL::Digest.new('sha256')
+      hmac_digest = OpenSSL::HMAC.digest(digest, secret_key, message)
+      Base64.encode64(hmac_digest).strip()
+    end
+
+    def parameter_message
+      return '' if parameter_collection.empty?
+      parameter_collection.map { |x| "#{x[0]}=#{x[1]}" }.join("&")
+    end
+
+    def parameter_collection
+      @parameter_collection ||= begin
+        collection = params.to_a + post_data.to_a
+        collection.sort
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spyfu
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Robert Graff
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-24 00:00:00.000000000 Z
+date: 2017-09-28 00:00:00.000000000 Z
 dependencies: []
 description: The unofficial ruby gem for Spyfu.com
 email: workman@internetfaction.com
@@ -17,7 +17,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - lib/spyfu.rb
+- lib/spyfu/api/ad_history.rb
+- lib/spyfu/api/base.rb
+- lib/spyfu/api/core.rb
+- lib/spyfu/api/kss.rb
+- lib/spyfu/api/leads.rb
+- lib/spyfu/api/url.rb
+- lib/spyfu/api/weekly_tracking.rb
+- lib/spyfu/client.rb
+- lib/spyfu/request.rb
 homepage: https://github.com/Workman/spyfu-rb
 licenses:
 - MIT
@@ -41,5 +52,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A simple API wrapper for Spyfu.com
+summary: SpyFu API
 test_files: []