similarweb 0.0.1

data/.gitignore

@@ -0,0 +1,36 @@
+.DS_Store
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+>>>>>>> 98e22f4287bbe6149ea46316b9adfd9e36f58684

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    similarweb (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.2.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    safe_yaml (1.0.2)
+    slop (3.5.0)
+    webmock (1.17.4)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  faraday
+  pry
+  rake
+  rspec
+  similarweb!
+  webmock

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Steven Lai, John McLaughlin
+
+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,153 @@
+<<<<<<< HEAD
+# Similarweb
+
+Ruby client for [SimilarWeb API](https://developer.similarweb.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'similarweb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install similarweb
+
+## Usage
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+traffic = client.traffic('disney.com')
+```
+
+### Also Visited
+
+Returns a list of websites frequently visited by users of the given domain.
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+also_visited = client.also_visited('disney.com')
+```
+
+### Category
+
+Will return a domain’s category and its global rank within its given category.
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+category = client.category('disney.com')
+```
+
+### Category Rank
+
+Will return a domain’s category and its global rank within its given category.
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+category_rank = client.category_rank('disney.com')
+```
+
+### Destinations
+
+Returns the 10 leading sites that receive direct clicks from the given domain.
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+destinations = client.destinations('disney.com')
+```
+
+### Engagement
+
+Provides three web engagement metrics: average page views, average time on site and bounce rate.
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+engagement = client.engagement('disney.com')
+```
+
+### Estimated Visits
+
+Returns the estimated number of visitors per domain.
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+visits = client.estimated_visits('disney.com')
+```
+
+### Keywords
+
+Access three search metrics: paid/organic search distribution, 10 paid keywords, and 10 organic keywords.
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+keywords = client.keywords('disney.com')
+```
+
+### Referrals
+
+Returns the 10 leading sites that direct clicks to the given domain.
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+referrals = client.referrals('disney.com')
+```
+
+### Similar Sites
+
+Input a domain and receive an output of 20 similar websites and their similarity score.
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+similar = client.similar_sites('disney.com')
+```
+
+### Social Referrals
+
+Access the five leading social networks sending traffic to the given domain.
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+social = client.social_referrals('disney.com')
+```
+
+### Tags
+
+Returns 10 tags per domain based on semantic analysis, meta-data, anchor text and more.
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+tags = client.tags('disney.com')
+```
+
+### Traffic
+
+Will return four web traffic metrics: global rank, country rank/traffic geography, traffic reach and traffic sources distribution.
+
+``` ruby
+client = SimilarWeb::Client.new(api_key: key)
+traffic = client.traffic('disney.com')
+```
+
+## Author
+[John McLaughlin](mailto:j@yar.com) & [Steven Lai](mailto:lai.steven@gmail.com)
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/similarweb/fork )
+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
+
+## Copyright
+Copyright (c) 2014 [John McLaughlin](mailto:j@yar.com), [Steven Lai](mailto:lai.steven@gmail.com).
+See [LICENSE][license] for details.
+
+[license]:   LICENSE.md
+=======
+similarweb
+==========
+>>>>>>> 98e22f4287bbe6149ea46316b9adfd9e36f58684

data/Rakefile

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

data/lib/similarweb/also_visited.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module AlsoVisited
+    def also_visited(domain)
+      response = self.http_client.get "#{domain}/v2/alsovisited?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/category.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module Category
+    def category(domain)
+      response = self.http_client.get "#{domain}/v2/category?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/category_rank.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module CategoryRank
+    def category_rank(domain)
+      response = self.http_client.get "#{domain}/v2/CategoryRank?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/client.rb

@@ -0,0 +1,31 @@
+module Similarweb
+  class Client
+    include AlsoVisited
+    include EstimatedVisits
+    include SimilarSites
+    include CategoryRank
+    include Destinations
+    include Keywords
+    include SocialReferrals
+    include Category
+    include Engagement
+    include Referrals
+    include Tags
+    include Traffic
+    attr_accessor :api_key, :http_client
+
+    def initialize(args = {})
+      args.each do |key, value|
+        send(:"#{key}=", value)
+      end
+      make_http_client!
+    end
+
+    private
+
+      def make_http_client!
+        base_url = "http://api.similarweb.com/Site/"
+        self.http_client = Faraday.new(:url => base_url)
+      end
+  end
+end

data/lib/similarweb/destinations.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module Destinations
+    def destinations(domain)
+      response = self.http_client.get "#{domain}/v2/leadingdestinationsites?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/engagement.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module Engagement
+    def engagement(domain)
+      response = self.http_client.get "#{domain}/v1/engagement?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/estimated_visits.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module EstimatedVisits
+    def estimated_visits(domain)
+      response = self.http_client.get "#{domain}/v1/EstimatedTraffic?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/keywords.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module Keywords
+    def keywords(domain)
+      response = self.http_client.get "#{domain}/v1/searchintelligence?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/referrals.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module Referrals
+    def referrals(domain)
+      response = self.http_client.get "#{domain}/v2/leadingreferringsites?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/similar_sites.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module SimilarSites
+    def similar_sites(domain)
+      response = self.http_client.get "#{domain}/v2/similarsites?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/social_referrals.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module SocialReferrals
+    def social_referrals(domain)
+      response = self.http_client.get "#{domain}/v1/socialreferringsites?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/tags.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module Tags
+    def tags(domain)
+      response = self.http_client.get "#{domain}/v2/tags?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/traffic.rb

@@ -0,0 +1,8 @@
+module Similarweb
+  module Traffic
+    def traffic(domain)
+      response = self.http_client.get "#{domain}/v1/traffic?Format=JSON&UserKey=#{self.api_key}"
+      JSON(response.body)
+    end
+  end
+end

data/lib/similarweb/version.rb

@@ -0,0 +1,3 @@
+module Similarweb
+  VERSION = "0.0.1"
+end

data/lib/similarweb.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+require 'json'
+
+require 'similarweb/version'
+require 'similarweb/also_visited'
+require 'similarweb/category'
+require 'similarweb/category_rank'
+require 'similarweb/destinations'
+require 'similarweb/engagement'
+require 'similarweb/estimated_visits'
+require 'similarweb/keywords'
+require 'similarweb/referrals'
+require 'similarweb/similar_sites'
+require 'similarweb/social_referrals'
+require 'similarweb/tags'
+require 'similarweb/traffic'
+require 'similarweb/client'
+
+
+module Similarweb
+end

data/similarweb.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'similarweb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "similarweb"
+  spec.version       = Similarweb::VERSION
+  spec.authors       = ["John McLaughlin", "Steven Lai"]
+  spec.email         = ["j@yar.com", "mailto:lai.steven@gmail.com"]
+  spec.summary       = %q{Ruby wrapper for Similarweb API}
+  spec.description   = %q{Ruby wrapper for Similarweb API}
+  spec.homepage      = "http://github.com/johnmcl/similarweb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "faraday"
+  spec.add_development_dependency "webmock"
+end

data/spec/similarweb/client_spec.rb

@@ -0,0 +1,434 @@
+require 'spec_helper'
+
+describe Similarweb::Client do
+  before do
+    @client = Similarweb::Client.new(api_key: 'test-key')
+  end
+
+  describe '.api_key' do
+    it 'should return the api key' do
+      expect( @client.api_key ).to eq('test-key')
+    end
+  end
+
+  describe '.referrals' do
+    before(:each) do
+      body = <<-eos
+        {
+         "Sites": [
+          "bleacherreport.com",
+          "spox.com",
+          "sportal.com.au",
+          "espn.go.com",
+          "en.wikipedia.org",
+          "nba.co.jp",
+          "search.tb.ask.com",
+          "gazzetta.it",
+          "baloncesto.as.com",
+          "forums.realgm.com"
+         ],
+         "StartDate": "01/2014",
+         "EndDate": "03/2014"
+        }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/example.com/v2/leadingreferringsites?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @referrals = @client.referrals('example.com')
+    end
+
+    it 'should return a list of referral sites' do
+      expect( @referrals ).to have_key('Sites')
+      expect( @referrals['Sites']).to be_a(Array)
+    end
+  end
+
+  describe '.keywords' do
+    before(:each) do
+      body = <<-eos
+        {
+         "OrganicSearchShare": 0.9894885348395134,
+         "PaidSearchShare": 0.010511465160486622,
+         "TopOrganicTerms": [
+          "nba",
+          "nba.com",
+          "nba standings",
+          "nba league pass",
+          "miami heat",
+          "nba store",
+          "lakers",
+          "chicago bulls",
+          "knicks",
+          "houston rockets"
+         ],
+         "TopPaidTerms": [
+          "nba store",
+          "nba",
+          "nba league pass",
+          "nba shop",
+          "nba.com",
+          "orlando magic",
+          "portland trail blazers",
+          "miami heat",
+          "nba jerseys",
+          "celtics"
+         ],
+         "StartDate": "01/2014",
+         "EndDate": "03/2014"
+        }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/example.com/v1/searchintelligence?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @keywords = @client.keywords('example.com')
+    end
+
+    it 'should return a ratio of organic search share' do
+      expect( @keywords ).to have_key('OrganicSearchShare')
+    end
+
+    it 'should return a ratio of paid search share' do
+      expect( @keywords ).to have_key('PaidSearchShare')
+    end
+
+    it 'should return a list of top organic search terms' do
+      expect( @keywords ).to have_key('TopOrganicTerms')
+      expect( @keywords['TopOrganicTerms'] ).to be_a(Array)
+    end
+
+    it 'should return a list of top paid terms' do
+      expect( @keywords ).to have_key('TopPaidTerms')
+      expect( @keywords['TopPaidTerms'] ).to be_a(Array)
+    end
+  end
+
+  describe '.estimated_visits' do
+    before(:each) do
+      body = <<-eos
+        {
+         "EstimatedVisitors": 81178601
+        }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/example.com/v1/EstimatedTraffic?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @estimated_visitors = @client.estimated_visits('example.com')
+    end
+
+    it 'should have estimated visitors' do
+      expect( @estimated_visitors ).to have_key('EstimatedVisitors')
+    end
+  end
+
+  describe '.engagement' do
+    before(:each) do
+      body = <<-eos
+        {
+         "AveragePageViews": 4.230206634619614,
+         "AverageTimeOnSite": 368.58524742011434,
+         "BounceRate": 0.2642082587520108,
+         "Date": "03/2014"
+        }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/example.com/v1/engagement?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @engagement = @client.engagement('example.com')
+    end
+
+    it 'should have average page views' do
+      expect( @engagement ).to have_key('AveragePageViews')
+    end
+
+    it 'should have average time on site' do
+      expect( @engagement ).to have_key('AverageTimeOnSite')
+    end
+
+    it 'should have bounce rate' do
+      expect( @engagement ).to have_key('BounceRate')
+    end
+
+    it 'should have date' do
+      expect( @engagement ).to have_key('Date')
+    end
+  end
+
+  describe '.destinations' do
+    before(:each) do
+      body = <<-eos
+          {
+           "Sites": [
+            "test.com",
+            "faketest.com"
+           ],
+           "StartDate": "01/2014",
+           "EndDate": "03/2014"
+          }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/example.com/v2/leadingdestinationsites?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @destinations = @client.destinations('example.com')
+    end
+
+    it 'should return a list of sites' do
+      expect( @destinations["Sites"] ).to be_a(Array)
+    end
+  end
+
+  describe '.category' do
+    before(:each) do
+      body = <<-eos
+        {
+         "Category": "Sports/Basketball"
+        }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/example.com/v2/category?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @category = @client.category('example.com')
+    end
+
+    it 'should return a category' do
+      expect( @category ).to have_key('Category')
+    end
+  end
+
+  describe '.category_rank' do
+    before(:each) do
+      body = <<-eos
+        {
+         "Category": "Sports/Basketball",
+         "CategoryRank": 1
+        }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/example.com/v2/CategoryRank?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @category_rank = @client.category_rank('example.com')
+    end
+
+    it 'should return a category' do
+      expect( @category_rank ).to have_key('Category')
+    end
+
+    it 'should return a rank' do
+      expect( @category_rank ).to have_key('CategoryRank')
+    end
+  end
+
+  describe '.also_visited' do
+    before(:each) do
+      body = <<-eos
+          {
+            "AlsoVisited": [
+              {
+                "Url": "nfl.com",
+                "Score": 0.005021070143807851
+              }
+            ]
+          }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/example.com/v2/alsovisited?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @also_visited_metrics = @client.also_visited('example.com')
+    end
+
+    it 'should return a list of also visited sites' do
+      expect(@also_visited_metrics["AlsoVisited"]).to be_a(Array)
+    end
+
+    describe 'similar site' do
+      it 'should have a url' do
+        expect(@also_visited_metrics["AlsoVisited"].first).to have_key('Url')
+      end
+
+      it 'should have a score' do
+        expect(@also_visited_metrics["AlsoVisited"].first).to have_key('Score')
+      end
+    end
+  end
+
+  describe '.traffic' do
+    before(:each) do
+      body = <<-eos
+          {
+           "GlobalRank": 327,
+           "CountryCode": 840,
+           "CountryRank": 251,
+           "TopCountryShares": [
+            {
+             "CountryCode": 840,
+             "TrafficShare": 0.4274051669391115
+            }]
+           }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/example.com/v1/traffic?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @traffic_metrics = @client.traffic('example.com')
+    end
+
+    it 'should return the traffic metrics with global rank' do
+      expect( @traffic_metrics ).to have_key('GlobalRank')
+    end
+
+    it 'should return the traffic metrics with country code' do
+      expect( @traffic_metrics ).to have_key('CountryCode')
+    end
+
+    it 'should return the traffic metrics with country rank' do
+      expect( @traffic_metrics ).to have_key('CountryRank')
+    end
+
+    it 'should return the traffic metrics with top country shares' do
+      expect( @traffic_metrics ).to have_key('TopCountryShares')
+    end
+
+    it 'should return a list of countries and the traffic share' do
+      expect( @traffic_metrics['TopCountryShares'] ).to be_a(Array)
+    end
+  end
+
+  describe '.similar_sites' do
+    before(:each) do
+      body = <<-eos
+        {
+         "SimilarSites": [
+          {
+           "Url": "pbskids.org",
+           "Score": 0.9012942574949001
+          },
+          {
+           "Url": "nick.com",
+           "Score": 0.7312487797958783
+          },
+          {
+           "Url": "kids.yahoo.com",
+           "Score": 0.6653412685291096
+          }
+          ]
+        }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/disney.com/v2/similarsites?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @similar_sites = @client.similar_sites('disney.com')
+    end
+
+    it 'should return a list of similar sites' do
+      expect(@similar_sites["SimilarSites"]).to be_a(Array)
+    end
+
+    describe 'site tags' do
+      it 'should have a name' do
+        expect(@similar_sites["SimilarSites"].first).to have_key('Url')
+      end
+
+      it 'should have a score' do
+        expect(@similar_sites["SimilarSites"].first).to have_key('Score')
+      end
+    end
+  end
+
+
+  describe '.social_referrals' do
+    before(:each) do
+      body = <<-eos
+          {
+            "SocialSources": [
+              {
+                "Source": "Youtube",
+                "Value": 0.699753626365037
+              },
+              { 
+                "Source": "Reddit", 
+                "Value": 0.06447515408116457
+              }
+            ]
+          }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/disney.com/v1/socialreferringsites?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @social_referrals = @client.social_referrals('disney.com')
+    end
+
+    it 'should return a list of social referrals' do
+      expect(@social_referrals["SocialSources"]).to be_a(Array)
+    end
+
+    describe 'site tags' do
+      it 'should have a name' do
+        expect(@social_referrals["SocialSources"].first).to have_key('Source')
+      end
+
+      it 'should have a score' do
+        expect(@social_referrals["SocialSources"].first).to have_key('Value')
+      end
+    end
+  end
+    
+  describe '.tags' do
+    before(:each) do
+      body = <<-eos
+          {
+            "Tags": [
+              {
+                "Name": "disney",
+                "Score": 0.4535382529673987
+              }, 
+              {
+                "Name": "kids", 
+                "Score": 0.16695504510907133
+              }
+            ]
+          }
+      eos
+
+      stub_request(:get, "http://api.similarweb.com/Site/disney.com/v2/tags?Format=JSON&UserKey=test-key").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.0'}).
+        to_return(:status => 200, :body => body, :headers => {})
+
+      @website_tags = @client.tags('disney.com')
+    end
+
+    it 'should return a list of tags' do
+      expect(@website_tags["Tags"]).to be_a(Array)
+    end
+
+    describe 'site tags' do
+      it 'should have a name' do
+        expect(@website_tags["Tags"].first).to have_key('Name')
+      end
+
+      it 'should have a score' do
+        expect(@website_tags["Tags"].first).to have_key('Score')
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before(:each) do
+  end
+end
+
+require 'webmock/rspec'
+require 'similarweb'
+
+WebMock.disable_net_connect!(allow_localhost: true)

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: similarweb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John McLaughlin
+- Steven Lai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for Similarweb API
+email:
+- j@yar.com
+- mailto:lai.steven@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/similarweb.rb
+- lib/similarweb/also_visited.rb
+- lib/similarweb/category.rb
+- lib/similarweb/category_rank.rb
+- lib/similarweb/client.rb
+- lib/similarweb/destinations.rb
+- lib/similarweb/engagement.rb
+- lib/similarweb/estimated_visits.rb
+- lib/similarweb/keywords.rb
+- lib/similarweb/referrals.rb
+- lib/similarweb/similar_sites.rb
+- lib/similarweb/social_referrals.rb
+- lib/similarweb/tags.rb
+- lib/similarweb/traffic.rb
+- lib/similarweb/version.rb
+- similarweb.gemspec
+- spec/similarweb/client_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/johnmcl/similarweb
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for Similarweb API
+test_files:
+- spec/similarweb/client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: