similarweb2.0 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cb9e9749119e091c3f00cb85422f2f1eeb49be5
+  data.tar.gz: 174ee1dcb40bb0e27053726835f6cd7b6664f0b0
+SHA512:
+  metadata.gz: 80742de448d4c151605aea8eb5e72e625745f13d66762021b77032cdec53afe4c0d2ad44b11b57115d81d519bc74bea221a3d599961c14425bbe27f800402aa0
+  data.tar.gz: 9a1c7c5a17d878f3c687332434fa042a134f4a9698b2f74e416db382ab057d191f77694f09b213d740f8661011b590792cdeeefa6767b116f7b4378c6d5ee9fc

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle/
+/Gemfile.lock
+/spec/reports/
+/tmp/
+*.bundle
+.DS_Store

data/Gemfile

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

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,41 @@
+# Similarweb2.0
+
+Latest Ruby client for [SimilarWeb API](https://developer.similarweb.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'similarweb2.0'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install similarweb2.0
+
+## Usage
+
+``` ruby
+client = Similarweb::Client.new(api_key: key)
+visit = client.desktop_visit('google.com', '2017-03', '2017-04', 'daily')
+```
+
+## Author
+[Harsh Vardhan Sharma](mailto:bonnyharsh1993@gmail.com)
+
+## Contributing
+
+1. Fork it ( http://github.com/harshvardhansharma/similarweb2.0/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 [Harsh Vardhan Sharma](mailto:bonnyharsh1993@gmail.com).
+See [LICENSE][license] for details.
+
+[license]:   LICENSE.md

data/Rakefile

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

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  override:
+    - RAILS_ENV=test bundle exec rspec

data/lib/similarweb/client.rb

@@ -0,0 +1,31 @@
+module Similarweb
+  class Client
+    include DesktopTraffic::Sources
+    include DesktopTraffic::SearchKeyword
+    include Traffic::BounceRate
+    include Traffic::PageView
+    include Traffic::Visit
+    include Traffic::VisitDuration
+    include Traffic::TotalEngagement
+
+    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/"
+        self.http_client = Faraday.new(:url => base_url) do |builder|
+          builder.request :url_encoded
+          builder.response :follow_redirects, limit: 3
+          builder.adapter Faraday.default_adapter
+        end
+      end
+  end
+end

data/lib/similarweb/desktop_traffic/search_keyword.rb

@@ -0,0 +1,19 @@
+module Similarweb
+  module DesktopTraffic
+    module SearchKeyword
+
+      # NOTE: start_date, end_date format: YYYY-MM
+
+      def organic_search_keyword(domain, start_date, end_date, limit = nil)
+        response = self.http_client.get "v1/website/#{domain}/traffic-sources/organic-search?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&limit=#{limit}"
+        JSON.parse(response.body)
+      end
+
+      def paid_search_keyword(domain, start_date, end_date, limit = nil)
+        response = self.http_client.get "v1/website/#{domain}/traffic-sources/paid-search?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&limit=#{limit}"
+        JSON.parse(response.body)
+      end
+
+    end
+  end
+end

data/lib/similarweb/desktop_traffic/sources.rb

@@ -0,0 +1,19 @@
+module Similarweb
+  module DesktopTraffic
+    module Sources
+
+      # NOTE: start_date, end_date format: YYYY-MM
+
+      def overview_share(domain, start_date, end_date)
+        response = self.http_client.get "v1/website/#{domain}/traffic-sources/overview-share?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&main_domain_only=false"
+        JSON.parse(response.body)
+      end
+
+      def overview(domain, start_date, end_date)
+        response = self.http_client.get "v1/website/#{domain}/traffic-sources/overview?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&main_domain_only=false"
+        JSON.parse(response.body)
+      end
+
+    end
+  end
+end

data/lib/similarweb/traffic/bounce_rate.rb

@@ -0,0 +1,19 @@
+module Similarweb
+  module Traffic
+    module BounceRate
+
+      # NOTE: start_date, end_date format: YYYY-MM
+
+      def desktop_bounce_rate(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v1/website/#{domain}/traffic-and-engagement/bounce-rate?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&main_domain_only=false&granularity=#{granularity}"
+        JSON.parse(response.body)
+      end
+
+      def mobile_bounce_rate(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v2/website/#{domain}/mobile-web/bounce-rate?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&granularity=#{frequency}"
+        JSON.parse(response.body)
+      end
+
+    end
+  end
+end

data/lib/similarweb/traffic/page_view.rb

@@ -0,0 +1,19 @@
+module Similarweb
+  module Traffic
+    module PageView
+
+      # NOTE: start_date, end_date format: YYYY-MM
+
+      def desktop_page_view(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v1/website/#{domain}/traffic-and-engagement/pages-per-visit?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&main_domain_only=false&granularity=#{granularity}"
+        JSON.parse(response.body)
+      end
+
+      def mobile_page_view(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v2/website/#{domain}/mobile-web/pages-per-visit?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&granularity=#{frequency}"
+        JSON.parse(response.body)
+      end
+
+    end
+  end
+end

data/lib/similarweb/traffic/total_engagement.rb

@@ -0,0 +1,29 @@
+module Similarweb
+  module Traffic
+    module TotalEngagement
+
+      # NOTE: start_date, end_date format: YYYY-MM
+
+      def visit(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v1/website/#{domain}/total-traffic-and-engagement/visits?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&main_domain_only=false&granularity=#{granularity}"
+        JSON.parse(response.body)
+      end
+
+      def pages_per_visit(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v1/website/#{domain}/total-traffic-and-engagement/pages-per-visit?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&main_domain_only=false&granularity=#{granularity}"
+        JSON.parse(response.body)
+      end
+
+      def average_visit_duration(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v1/website/#{domain}/total-traffic-and-engagement/average-visit-duration?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&main_domain_only=false&granularity=#{granularity}"
+        JSON.parse(response.body)
+      end
+
+      def bounce_rate(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v1/website/#{domain}/total-traffic-and-engagement/bounce-rate?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&main_domain_only=false&granularity=#{granularity}"
+        JSON.parse(response.body)
+      end
+
+    end
+  end
+end

data/lib/similarweb/traffic/visit.rb

@@ -0,0 +1,19 @@
+module Similarweb
+  module Traffic
+    module Visit
+
+      # NOTE: start_date, end_date format: YYYY-MM
+
+      def desktop_visit(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v1/website/#{domain}/traffic-and-engagement/visits?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&main_domain_only=false&granularity=#{granularity}"
+        JSON.parse(response.body)
+      end
+
+      def mobile_visit(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v2/website/#{domain}/mobile-web/visits?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&granularity=#{granularity}"
+        JSON.parse(response.body)
+      end
+
+    end
+  end
+end

data/lib/similarweb/traffic/visit_duration.rb

@@ -0,0 +1,19 @@
+module Similarweb
+  module Traffic
+    module VisitDuration
+
+      # NOTE: start_date, end_date format: YYYY-MM
+
+      def desktop_visit_duration(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v1/website/#{domain}/traffic-and-engagement/average-visit-duration?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&main_domain_only=false&granularity=#{granularity}"
+        JSON.parse(response.body)
+      end
+
+      def mobile_visit_duration(domain, start_date, end_date, granularity = 'daily')
+        response = self.http_client.get "v2/website/#{domain}/mobile-web/average-visit-duration?api_key=#{self.api_key}&start_date=#{start_date}&end_date=#{end_date}&granularity=#{frequency}"
+        JSON.parse(response.body)
+      end
+
+    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,16 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+
+require 'similarweb/version'
+require 'similarweb/desktop_traffic/search_keyword'
+require 'similarweb/desktop_traffic/sources'
+require 'similarweb/traffic/bounce_rate'
+require 'similarweb/traffic/page_view'
+require 'similarweb/traffic/total_engagement'
+require 'similarweb/traffic/visit'
+require 'similarweb/traffic/visit_duration'
+require 'similarweb/client'
+
+module Similarweb
+end

data/similarweb2.gemspec

@@ -0,0 +1,28 @@
+# 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          = 'similarweb2.0'
+  spec.version       = Similarweb::VERSION
+  spec.authors       = ['Harsh Vardhan Sharma']
+  spec.email         = ['bonnyharsh1993@gmail.com']
+  spec.summary       = %q{Ruby wrapper for Similarweb API}
+  spec.description   = %q{Ruby wrapper for Similarweb API}
+  spec.homepage      = 'https://github.com/harshvardhansharma/similarweb2.0'
+  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 'webmock'
+
+  spec.add_runtime_dependency 'faraday', '~>0.12.1'
+  spec.add_runtime_dependency 'faraday_middleware', '~>0.11'
+end

data/spec/similarweb/client_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Similarweb::Client do
+
+  let(:api_key) { 'abcde-12345' }
+
+  before do
+    @client = Similarweb::Client.new(api_key: api_key)
+  end
+
+  describe '.api_key' do
+    it 'should return the api key' do
+      expect( @client.api_key ).to eq(api_key)
+    end
+  end
+
+  describe '.desktop_visit' do
+    before(:each) do
+      body = <<-eos
+        {
+          "meta": {
+            "request": {
+              "granularity": "Daily",
+              "main_domain_only": false,
+              "domain": "example.com",
+              "country": "world"
+            },
+            "status": "Success",
+            "last_updated": "2017-01-17"
+          },
+          "visits": [
+            {
+              "date": "2017-01-16",
+              "visits": 1328398.73631
+            },
+            {
+              "date": "2017-01-17",
+              "visits": 1547400.88473
+            }
+          ]
+        }
+      eos
+
+      start_date = '2017-02'
+      end_date = '2017-03'
+
+      stub_request(:get, "http://api.similarweb.com/v1/website/example.com/traffic-and-engagement/visits?api_key=#{api_key}&end_date=#{end_date}&granularity=daily&main_domain_only=false&start_date=#{start_date}").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.12.1'}).
+        to_return(:status => 200, :body => body, :headers => {})
+      @desktop_visit = @client.desktop_visit('example.com', start_date, end_date)
+    end
+
+    it 'should return a list of desktop_visit' do
+      expect( @desktop_visit ).to have_key('visits')
+      expect( @desktop_visit['visits']).to be_a(Array)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# 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|
+  # 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'
+end
+
+require 'webmock/rspec'
+require 'similarweb'
+
+WebMock.disable_net_connect!(allow_localhost: true)

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: similarweb2.0
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Harsh Vardhan Sharma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: webmock
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Ruby wrapper for Similarweb API
+email:
+- bonnyharsh1993@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- circle.yml
+- lib/similarweb.rb
+- lib/similarweb/client.rb
+- lib/similarweb/desktop_traffic/search_keyword.rb
+- lib/similarweb/desktop_traffic/sources.rb
+- lib/similarweb/traffic/bounce_rate.rb
+- lib/similarweb/traffic/page_view.rb
+- lib/similarweb/traffic/total_engagement.rb
+- lib/similarweb/traffic/visit.rb
+- lib/similarweb/traffic/visit_duration.rb
+- lib/similarweb/version.rb
+- similarweb2.gemspec
+- spec/similarweb/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/harshvardhansharma/similarweb2.0
+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.8
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Similarweb API
+test_files:
+- spec/similarweb/client_spec.rb
+- spec/spec_helper.rb