similarweb-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e4b723bcbe863069ef0305900a3eb98a824e18c
+  data.tar.gz: 6c4d1a1f8b495a7ea209c2c9f3015fc913a01ced
+SHA512:
+  metadata.gz: 86013e70a8cca25106427e83ddbd0fe9a80f5ecbf2e50e343870032efe53d1caba1f3ef94be816e658cf8ef3b6a00f8f5e893e9b804eb7b145cafd9af82a401c
+  data.tar.gz: 67157abcd2b8bffe2841b590b3a988758502c67d5378c67e0d0a9b0367e5b389565af55f11a4c0b52d1f08f702c44430b11b0ea9c75ffdf23683047b11018713

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in similarweb-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    similarweb-api (0.0.2)
+      dry-configurable
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry-byebug
+  rake (~> 10.0)
+  similarweb-api!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,35 @@
+# Similarweb::Api
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/similarweb/api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'similarweb-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install similarweb-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/similarweb-api.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "similarweb"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/similarweb.rb

@@ -0,0 +1,6 @@
+require 'faraday'
+require 'json'
+require 'similarweb/client'
+
+module Similarweb
+end

data/lib/similarweb/client.rb

@@ -0,0 +1,24 @@
+require 'dry-configurable'
+require 'date'
+
+require_relative 'client/total_traffic_and_engagement'
+
+module Similarweb
+  class Client
+    extend Dry::Configurable
+    extend TotalTrafficAndEngagement
+    setting :api_key
+    setting :url, 'https://api.similarweb.com/v1/website/'
+    setting :start_date, Date.today.prev_month.strftime('%Y-%m')
+    setting :end_date, Date.today.prev_month.strftime('%Y-%m')
+    setting :granularity, :monthly
+    setting :main_domain_only, false
+
+    def self.make_request!(url, params)
+      merged_params = Similarweb::Client.config.to_h.merge(params)
+      http_client = Faraday.new(url: Similarweb::Client.config.url, params: merged_params)
+      JSON(http_client.get(url).body)
+    end
+
+  end
+end

data/lib/similarweb/client/total_traffic_and_engagement.rb

@@ -0,0 +1,18 @@
+module Similarweb
+  module TotalTrafficAndEngagement
+    def visits(domain, params = {})
+      url = "#{domain}/total-traffic-and-engagement/visits"
+      self.make_request!(url, params)
+    end
+
+    def average_visit_duration(domain, params = {})
+      url = "#{domain}/total-traffic-and-engagement/average-visit-duration"
+      self.make_request!(url, params)
+    end
+
+    def pages_per_visit(domain, params = {})
+      url = "#{domain}/total-traffic-and-engagement/pages-per-visit"
+      self.make_request!(url, params)
+    end
+  end
+end

data/lib/similarweb/version.rb

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

data/similarweb-api.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "similarweb/version"
+# require "similarweb"
+
+Gem::Specification.new do |spec|
+  spec.name          = "similarweb-api"
+  spec.version       = Similarweb::VERSION
+  spec.authors       = ["Aleksey Yudin"]
+  spec.email         = ["qaa12work@gmail.com"]
+
+  spec.summary       = %q{Simple ruby wrapper for SimilarWeb API }
+  spec.description   = %q{Simple ruby wrapper for SimilarWeb API }
+  spec.homepage      = ""
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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.required_ruby_version = '>= 2.1'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "dry-configurable"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_runtime_dependency "faraday"
+  # gem.add_runtime_dependency("json", ">= 1.8")
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: similarweb-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aleksey Yudin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Simple ruby wrapper for SimilarWeb API '
+email:
+- qaa12work@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/similarweb.rb
+- lib/similarweb/client.rb
+- lib/similarweb/client/total_traffic_and_engagement.rb
+- lib/similarweb/version.rb
+- similarweb-api.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Simple ruby wrapper for SimilarWeb API
+test_files: []