statcounter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a07f45e20aad61cd55786e84bcb777ecb6cffb6
+  data.tar.gz: 0b47936f0a2454d253e5e896572027c4df974c81
+SHA512:
+  metadata.gz: 67f0ac03e7fa837d29d93a1648f75c7a50216a7485a841b4d8a8a9b0b5740ed4ab072476beb068dfe614a047382375ae7bdfdef0ab631fee7116cf2acb86cb6e
+  data.tar.gz: f077806e3fd8d8b7005e827f3dd87c112ee838bafc7b817e0434461be6dee54fd4d73c81af9c20d11653b2d808cbd205f5f038ef019b0b15770097657eac0e63

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,17 @@
+LineLength:
+  Max: 100
+
+Documentation:
+  Enabled: false
+
+SignalException:
+  EnforcedStyle: only_raise
+
+ClassAndModuleChildren:
+  Enabled: false
+
+TrailingCommaInLiteral:
+  Enabled: false
+
+TrailingCommaInArguments:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.1.1
+script: 'bundle exec rspec'
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,4 @@
+# Statcounter
+
+TODO: Add readme
+

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+
+task default: :spec

data/lib/statcounter.rb

@@ -0,0 +1,28 @@
+require 'statcounter/version'
+require 'statcounter/client'
+require 'statcounter/configuration'
+require 'statcounter/errors'
+require 'statcounter/params_encoder'
+require 'statcounter/projects'
+
+module Statcounter
+  API_URL = 'http://api.statcounter.com/'.freeze
+
+  module_function
+
+  def configure
+    yield(config)
+  end
+
+  def config
+    @config ||= Configuration.new
+  end
+
+  def client
+    @client ||= Client.new
+  end
+
+  def default_credentials
+    @default_credentials ||= { username: config.username, secret: config.secret }
+  end
+end

data/lib/statcounter/client.rb

@@ -0,0 +1,43 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Statcounter
+  class Client
+    STATUS_FAIL = 'fail'.freeze
+
+    def get(path, params: {}, credentials: nil)
+      response = connection(credentials).get(path, params)
+      body = JSON.parse(response.body, symbolize_names: true)
+
+      if body[:@attributes][:status] == STATUS_FAIL
+        raise Error, body[:error][0][:description]
+      end
+
+      body
+    rescue Faraday::ClientError => e
+      raise Error, 'Server could not process your request'
+    end
+
+    private
+
+    def connection(credentials)
+      @connection ||= build_connection(credentials)
+    end
+
+    def build_connection(credentials)
+      Faraday.new(url: Statcounter::API_URL) do |c|
+        c.adapter Faraday.default_adapter
+        c.use FaradayMiddleware::FollowRedirects, limit: 3
+        c.response :json, content_type: /\bjson$/
+        c.response :raise_error
+        c.options[:timeout] = config.timeout
+        c.options[:open_timeout] = config.timeout
+        c.options[:params_encoder] = Statcounter::ParamsEncoder.new(credentials)
+      end
+    end
+
+    def config
+      Statcounter.config
+    end
+  end
+end

data/lib/statcounter/configuration.rb

@@ -0,0 +1,9 @@
+module Statcounter
+  class Configuration
+    attr_accessor :username, :secret, :timeout
+
+    def timeout
+      @timeout ||= 60
+    end
+  end
+end

data/lib/statcounter/errors.rb

@@ -0,0 +1,3 @@
+module Statcounter
+  class Error < StandardError; end
+end

data/lib/statcounter/params_encoder.rb

@@ -0,0 +1,38 @@
+module Statcounter
+  class ParamsEncoder
+    def initialize(credentials)
+      @credentials = credentials || Statcounter.default_credentials
+    end
+
+    def encode(params)
+      return unless params.is_a? Hash
+
+      query_string = hash_to_query_string(request_params(params))
+      sha1 = generate_sha1(query_string)
+
+      "#{query_string}&sha1=#{sha1}"
+    end
+
+    private
+
+    def request_params(params)
+      params[:vn] ||= 3
+      params[:t] ||= Time.now.to_i
+      params[:u] ||= @credentials[:username]
+      params[:f] ||= :json
+      params
+    end
+
+    def hash_to_query_string(hash)
+      hash.each_with_object('') do |(key, value), query_string|
+        next value.each { |v| query_string << "#{key}=#{v}&" } if value.is_a? Array
+
+        query_string << "#{key}=#{value}&"
+      end.chomp('&')
+    end
+
+    def generate_sha1(query_string)
+      Digest::SHA1.hexdigest('?' + query_string + @credentials[:secret])
+    end
+  end
+end

data/lib/statcounter/projects.rb

@@ -0,0 +1,14 @@
+module Statcounter
+  class Projects
+    def self.all(credentials: nil)
+      response = Statcounter.client.get('user_projects', credentials: credentials)
+      response[:sc_data]
+    end
+
+    def self.find(project_id, credentials: nil)
+      params = { pi: project_id }
+      response = Statcounter.client.get('select_project', params: params, credentials: credentials)
+      response[:sc_data][0]
+    end
+  end
+end

data/lib/statcounter/version.rb

@@ -0,0 +1,3 @@
+module Statcounter
+  VERSION = '0.1.0'.freeze
+end

data/spec/assets/failure.json

@@ -0,0 +1,9 @@
+{
+  "@attributes": {
+    "status": "fail"
+  },
+  "error": [{
+    "code": "CODE",
+    "description": "ERROR_DESCRIPTION"
+  }]
+}

data/spec/assets/select_project.json

@@ -0,0 +1,14 @@
+{
+  "@attributes": {
+    "status":"ok"
+  },
+  "sc_data":[{
+    "project_name":"PROJECT_NAME",
+    "log_size": "LOG_SIZE",
+    "timezone": "TIME_ZONE",
+    "url":"URL",
+    "log_oldest_entry":"LOG_OLDEST_ENTRY",
+    "log_latest_entry":"LOG_LATEST_ENTRY",
+    "created_at":"CREATED_AT"
+  }]
+}

data/spec/assets/user_projects.json

@@ -0,0 +1,47 @@
+{
+   "@attributes":{
+      "status":"ok"
+   },
+   "sc_data":[
+      {
+         "project_id":"1000000",
+         "project_name":"mywebsite1.com",
+         "url":"https:\/\/www.mywebsite1.com",
+         "project_group_id":"2",
+         "project_group_name":"Websites 2",
+         "hidden_group":"0"
+      },
+      {
+         "project_id":"1000001",
+         "project_name":"mywebsite2.com",
+         "url":"https:\/\/www.mywebsite2.com",
+         "project_group_id":"2",
+         "project_group_name":"Websites 2",
+         "hidden_group":"0"
+      },
+      {
+         "project_id":"1000002",
+         "project_name":"mywebsite3.com",
+         "url":"https:\/\/www.mywebsite3.com\/",
+         "project_group_id":"1",
+         "project_group_name":"Websites 1",
+         "hidden_group":"0"
+      },
+      {
+         "project_id":"1000003",
+         "project_name":"mywebsite4.com",
+         "url":"https:\/\/www.mywebsite4.com",
+         "project_group_id":"1",
+         "project_group_name":"Websites 1",
+         "hidden_group":"0"
+      },
+      {
+         "project_id":"1000004",
+         "project_name":"mywebsite5.com",
+         "url":"https:\/\/www.mywebsite5.com",
+         "project_group_id":"1",
+         "project_group_name":"Websites 1",
+         "hidden_group":"0"
+      }
+   ]
+}

data/spec/client_spec.rb

@@ -0,0 +1,36 @@
+RSpec.describe Statcounter::Client do
+  describe '#get' do
+    subject { described_class.new.get('user_projects', credentials: default_credentials) }
+    let(:response_body) { 'spec/assets/user_projects.json' }
+    let(:response_status) { 200 }
+
+    before do
+      Timecop.freeze(Time.at(1466614800))
+      stub_request(:get, 'http://api.statcounter.com/user_projects?f=json&sha1=06290316a4a4aa9911db04b42294609a8a4694e4&t=1466614800&u=john_brown&vn=3')
+        .to_return(body: File.read(response_body), status: response_status)
+    end
+
+    shared_examples 'raises error' do
+      it 'raises an exception' do
+        expect { subject }.to raise_error(Statcounter::Error)
+      end
+    end
+
+    it 'returns body' do
+      expect(subject[:sc_data]).to be_instance_of Array
+      expect(subject[:sc_data].first).to include(:project_id)
+    end
+
+    context 'when failure response' do
+      let(:response_body) { 'spec/assets/failure.json' }
+
+      it_behaves_like 'raises error'
+    end
+
+    context 'when client error' do
+      let(:response_status) { 500 }
+
+      it_behaves_like 'raises error'
+    end
+  end
+end

data/spec/params_encoder_spec.rb

@@ -0,0 +1,52 @@
+RSpec.describe Statcounter::ParamsEncoder do
+  subject(:params_encoder) { described_class.new(credentials) }
+  let(:credentials) { nil }
+
+  before { allow(Statcounter).to receive(:default_credentials).and_return(default_credentials) }
+
+  describe '#encode' do
+    subject(:query) { params_encoder.encode(params) }
+    let(:params) { { test: 1 } }
+    let(:parsed_query) { Rack::Utils.parse_nested_query(subject) }
+
+    before { Timecop.freeze }
+
+    it 'appends default params' do
+      expect(parsed_query).to include(
+        'vn' => '3',
+        't' => Time.now.to_i.to_s,
+        'f' => 'json',
+        'u' => default_credentials[:username],
+        'test' => '1',
+      )
+
+      expect(parsed_query).to include('sha1')
+    end
+
+    context 'when default param is given' do
+      let(:params) { { vn: 4 } }
+
+      it 'uses given param value' do
+        expect(parsed_query).to include('vn' => '4')
+      end
+    end
+
+    context 'when custom credentials given' do
+      let(:credentials) { { username: username, secret: secret } }
+      let(:username) { 'tom_brown' }
+      let(:secret) { 'toms_little_secret' }
+
+      it 'uses default credentials' do
+        expect(parsed_query).to include('u' => username)
+      end
+    end
+
+    context 'when param is array' do
+      let(:params) { { test: [1, 2] } }
+
+      it 'builds flat query' do
+        expect(query).to match(/test=1&test=2/)
+      end
+    end
+  end
+end

data/spec/projects_spec.rb

@@ -0,0 +1,47 @@
+RSpec.describe Statcounter::Projects do
+  before { Timecop.freeze(Time.at(1466614800)) }
+
+  describe '.all' do
+    subject { described_class.all(credentials: default_credentials) }
+
+    before do
+      stub_request(:get, 'http://api.statcounter.com/user_projects?f=json&sha1=06290316a4a4aa9911db04b42294609a8a4694e4&t=1466614800&u=john_brown&vn=3')
+        .to_return(body: File.read('spec/assets/user_projects.json'))
+    end
+
+    it 'returns projects array' do
+      expect(subject).to be_instance_of Array
+      expect(subject.first).to include(
+        :project_id,
+        :project_name,
+        :url,
+        :project_group_id,
+        :project_group_name,
+        :hidden_group,
+      )
+    end
+  end
+
+  describe '.find' do
+    subject { described_class.find(project_id, credentials: default_credentials) }
+    let(:project_id) { 1 }
+
+    before do
+      stub_request(:get, 'http://api.statcounter.com/select_project?f=json&pi=1&sha1=229b79fa8787e1a8bf8d09c3a1cbec96a8219364&t=1466614800&u=john_brown&vn=3')
+        .to_return(body: File.read('spec/assets/select_project.json'))
+    end
+
+    it 'returns project details' do
+      expect(subject).to be_instance_of Hash
+      expect(subject).to include(
+        :project_name,
+        :log_size,
+        :timezone,
+        :url,
+        :log_oldest_entry,
+        :log_latest_entry,
+        :created_at,
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'statcounter'
+require 'timecop'
+require 'rack'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!
+
+Dir['./spec/support/**/*.rb'].each { |f| require(f) }
+
+RSpec.configure do |config|
+  config.order = :random
+end

data/spec/support/request_stubbing.rb

@@ -0,0 +1,9 @@
+module RequestStubbing
+  def default_credentials
+    { username: 'john_brown', secret: 'johns_little_secret' }
+  end
+end
+
+RSpec.configure do |config|
+  config.include RequestStubbing
+end

data/statcounter.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'statcounter/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'statcounter'
+  spec.platform = Gem::Platform::RUBY
+  spec.version = Statcounter::VERSION
+  spec.authors = ['Šarūnas Kūjalis']
+  spec.email = ['sarjalis@gmail.com']
+  spec.summary = 'Ruby Statcounter API wrapper'
+  spec.homepage = 'https://github.com/ksarunas/statcounter'
+
+  spec.files = `git ls-files`.split($/)
+  spec.test_files = `git ls-files -- {spec}/*`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.10'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'timecop', '~> 0.8.1'
+  spec.add_development_dependency 'rack', '~> 1.6.4'
+  spec.add_development_dependency 'webmock', '~> 1.24'
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: statcounter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "Šarūnas Kūjalis"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+description: 
+email:
+- sarjalis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/statcounter.rb
+- lib/statcounter/client.rb
+- lib/statcounter/configuration.rb
+- lib/statcounter/errors.rb
+- lib/statcounter/params_encoder.rb
+- lib/statcounter/projects.rb
+- lib/statcounter/version.rb
+- spec/assets/failure.json
+- spec/assets/select_project.json
+- spec/assets/user_projects.json
+- spec/client_spec.rb
+- spec/params_encoder_spec.rb
+- spec/projects_spec.rb
+- spec/spec_helper.rb
+- spec/support/request_stubbing.rb
+- statcounter.gemspec
+homepage: https://github.com/ksarunas/statcounter
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Ruby Statcounter API wrapper
+test_files: []