statcounter 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a07f45e20aad61cd55786e84bcb777ecb6cffb6
-  data.tar.gz: 0b47936f0a2454d253e5e896572027c4df974c81
+  metadata.gz: b22c925b0a6e4979a589c600ce5a14a7fdac3470
+  data.tar.gz: 6839234079b43d0ad9e5009c314c50c15507e554
 SHA512:
-  metadata.gz: 67f0ac03e7fa837d29d93a1648f75c7a50216a7485a841b4d8a8a9b0b5740ed4ab072476beb068dfe614a047382375ae7bdfdef0ab631fee7116cf2acb86cb6e
-  data.tar.gz: f077806e3fd8d8b7005e827f3dd87c112ee838bafc7b817e0434461be6dee54fd4d73c81af9c20d11653b2d808cbd205f5f038ef019b0b15770097657eac0e63
+  metadata.gz: dde7493e662532d654e4744d0808923df5d92912a17b1937f730252995226169d983026e69c64aeacf2e7c7c5e3b0c4df37e589a5b844daf790e7a0a47b503a8
+  data.tar.gz: 8ef5c97b4f29bb6bd7378c8a11b93e9ebc48dc8c305c4fa1b239fb1e830f988d321a341622789da61d481c048f91042edc583772e3b052363013a3f198940110

data/.rubocop.yml

@@ -15,3 +15,6 @@ TrailingCommaInLiteral:
 
 TrailingCommaInArguments:
   Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.2.2

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

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

data/README.md

@@ -1,4 +1,184 @@
 # Statcounter
 
-TODO: Add readme
+[![Build Status](https://secure.travis-ci.org/ksarunas/statcounter.png)](http://travis-ci.org/ksarunas/statcounter)
+[![Gem Version](https://badge.fury.io/rb/statcounter.png)](http://badge.fury.io/rb/statcounter)
 
+Ruby Statcounter API wrapper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'statcounter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install statcounter
+
+## Initialization
+
+```ruby
+# config/initializers/statcounter.rb
+
+Statcounter.configure do |config|
+  config.username = 'STATCOUNTER_USERNAME_HERE'
+  config.secret = 'STATCOUNTER_API_PASSWORD_HERE'
+  config.timeout = 60 # default is 60
+  config.timezone = 'America/New_York' #default is America/New_York
+end
+```
+
+In case your app has to handle multiple Statcounter accounts you can pass credentials to each endpoint wrapper method like this:
+
+```ruby
+Statcounter::Projects.all(username: 'STATCOUNTER_USERNAME_HERE', secret: 'STATCOUNTER_API_PASSWORD_HERE')
+```
+
+## Examples
+
+### Projects
+
+#### Get all your projects
+```ruby
+Statcounter::Projects.all
+
+# returns array of project hashes
+[
+  {
+    project_id: '1000000',
+    project_name: 'mywebsite1.com',
+    url: 'https://www.mywebsite1.com',
+    project_group_id: '1',
+    project_group_name: 'Websites',
+    hidden_group: '0',
+  },
+]
+```
+
+#### Find projects
+
+When selecting one projects:
+
+```ruby
+Statcounter::Projects.find(1000000)
+
+# returns project hash
+{
+  project_name: 'mywebsite1.com',
+  log_size:  '500',
+  timezone:  'America/New_York',
+  url: 'https://www.mywebsite1.com',
+  log_oldest_entry: 'LOG_OLDEST_ENTRY',
+  log_latest_entry: 'LOG_LATEST_ENTRY',
+  created_at: 'CREATED_AT'
+}
+```
+
+When selecting multiple projects:
+
+```ruby
+Statcounter::Projects.find([1000000, 1000001])
+
+# returns array of project hashes
+[
+  {
+    project_name: 'mywebsite1.com',
+    log_size:  '500',
+    timezone:  'America/New_York',
+    url: 'https://www.mywebsite1.com',
+    log_oldest_entry: 'LOG_OLDEST_ENTRY',
+    log_latest_entry: 'LOG_LATEST_ENTRY',
+    created_at: 'CREATED_AT'
+  },
+  {
+    project_name: 'mywebsite2.com',
+    log_size:  '500',
+    timezone:  'America/New_York',
+    url: 'https://www.mywebsite2.com',
+    log_oldest_entry: 'LOG_OLDEST_ENTRY',
+    log_latest_entry: 'LOG_LATEST_ENTRY',
+    created_at: 'CREATED_AT'
+  }
+]
+```
+
+#### Create project
+
+```ruby
+Statcounter::Projects.create(
+  project_name: 'mywebsite1.com',
+  url: 'https://www.mywebsite2.com',
+  public_stats: true, # default false
+)
+
+# returns hash with id and security code
+{
+  project_id: '1000000',
+  security_code: 'hjk89077hh',
+}
+```
+
+### Summary stats
+
+#### Get daily
+
+When one project:
+
+```ruby
+Statcounter::SummaryStats.daily(
+  project_ids: 1000,
+  date_from: Date.yesterday,
+  date_to: Date.yesterday,
+)
+
+# Returns array of summary stats by date
+
+[
+  {
+    date: '2016-07-04',
+    page_views: '876',
+    unique_visits: '609',
+    returning_visits: '57',
+    first_time_visits: '552',
+  }
+]
+```
+
+When multiple projects:
+
+```ruby
+Statcounter::SummaryStats.daily(
+  project_ids: [1000, 1001],
+  date_from: Date.yesterday,
+  date_to: Date.yesterday,
+)
+
+# Returns hash where key is project id and value is array of summery stats by date
+
+{
+  1000 => [
+    {
+      date: '2016-07-04',
+      page_views: '876',
+      unique_visits: '609',
+      returning_visits: '57',
+      first_time_visits: '552',
+    }
+  ],
+  1001 => [
+    {
+      date: '2016-07-04',
+      page_views: '876',
+      unique_visits: '609',
+      returning_visits: '57',
+      first_time_visits: '552',
+    }
+  ],
+}
+```

data/lib/statcounter.rb

@@ -4,6 +4,7 @@ require 'statcounter/configuration'
 require 'statcounter/errors'
 require 'statcounter/params_encoder'
 require 'statcounter/projects'
+require 'statcounter/summary_stats'
 
 module Statcounter
   API_URL = 'http://api.statcounter.com/'.freeze

data/lib/statcounter/configuration.rb

@@ -1,9 +1,13 @@
 module Statcounter
   class Configuration
-    attr_accessor :username, :secret, :timeout
+    attr_accessor :username, :secret, :timeout, :timezone
 
     def timeout
       @timeout ||= 60
     end
+
+    def timezone
+      @timezone ||= 'America/New_York'
+    end
   end
 end

data/lib/statcounter/projects.rb

@@ -5,9 +5,20 @@ module Statcounter
       response[:sc_data]
     end
 
-    def self.find(project_id, credentials: nil)
-      params = { pi: project_id }
+    def self.find(project_ids, credentials: nil)
+      params = { pi: project_ids }
       response = Statcounter.client.get('select_project', params: params, credentials: credentials)
+      response[:sc_data].size > 1 ? response[:sc_data] : response[:sc_data][0]
+    end
+
+    def self.create(project_name:, url:, public_stats: false, credentials: nil)
+      params = {
+        wt: project_name,
+        wu: url,
+        ps: public_stats ? 1 : 0,
+      }
+
+      response = Statcounter.client.get('add_project', params: params, credentials: credentials)
       response[:sc_data][0]
     end
   end

data/lib/statcounter/summary_stats.rb

@@ -0,0 +1,25 @@
+module Statcounter
+  class SummaryStats
+    def self.daily(project_ids:, date_from:, date_to:, credentials: nil)
+      params = {
+        s: :summary,
+        g: :daily,
+        pi: project_ids,
+        sd: date_from.day,
+        sm: date_from.month,
+        sy: date_from.year,
+        ed: date_to.day,
+        em: date_to.month,
+        ey: date_to.year,
+      }
+      response = Statcounter.client.get('stats', params: params, credentials: credentials)
+      if response[:project]
+        response[:project].each_with_object({}) do |project, result|
+          result[project[:id].to_i] = project[:sc_data]
+        end
+      else
+        response[:sc_data]
+      end
+    end
+  end
+end

data/lib/statcounter/version.rb

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

data/spec/assets/add_project.json

@@ -0,0 +1,9 @@
+{
+  "@attributes": {
+    "status": "ok"
+  },
+  "sc_data": [{
+    "project_id": "123123123",
+    "security_code": "hjk89077hh"
+  }]
+}

data/spec/assets/select_project_multiple.json

@@ -0,0 +1,25 @@
+{
+  "@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"
+    },
+    {
+      "project_name":"PROJECT_NAME2",
+      "log_size": "LOG_SIZE",
+      "timezone": "TIME_ZONE",
+      "url":"URL2",
+      "log_oldest_entry":"LOG_OLDEST_ENTRY",
+      "log_latest_entry":"LOG_LATEST_ENTRY",
+      "created_at":"CREATED_AT"
+    }
+  ]
+}

data/spec/assets/summary_stats_daily.json

@@ -0,0 +1,14 @@
+{
+  "@attributes":{
+    "status":"ok"
+  },
+  "sc_data":[
+    {
+      "date":"2016-06-28",
+      "page_views":"876",
+      "unique_visits":"609",
+      "returning_visits":"57",
+      "first_time_visits":"552"
+    }
+  ]
+}

data/spec/assets/summary_stats_daily_multiple.json

@@ -0,0 +1,31 @@
+{
+  "@attributes":{
+    "status":"ok"
+  },
+  "project":[
+    {
+      "id":"1",
+      "sc_data":[
+        {
+          "date":"2016-06-28",
+          "page_views":"876",
+          "unique_visits":"609",
+          "returning_visits":"57",
+          "first_time_visits":"552"
+        }
+      ]
+    },
+    {
+      "id":"2",
+      "sc_data":[
+        {
+          "date":"2016-06-28",
+          "page_views":"28",
+          "unique_visits":"25",
+          "returning_visits":"7",
+          "first_time_visits":"18"
+        }
+      ]
+    }
+  ]
+}

data/spec/projects_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe Statcounter::Projects 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')
+      stub_request(:get, 'http://api.statcounter.com/user_projects?vn=3&t=1466614800&u=john_brown&f=json&sha1=06290316a4a4aa9911db04b42294609a8a4694e4')
         .to_return(body: File.read('spec/assets/user_projects.json'))
     end
 
@@ -23,13 +23,12 @@ RSpec.describe Statcounter::Projects do
   end
 
   describe '.find' do
-    subject { described_class.find(project_id, credentials: default_credentials) }
-    let(:project_id) { 1 }
+    subject { described_class.find(project_ids, credentials: default_credentials) }
+    let(:project_ids) { 1 }
+    let(:request_uri) { 'http://api.statcounter.com/select_project?pi=1&vn=3&t=1466614800&u=john_brown&f=json&sha1=229b79fa8787e1a8bf8d09c3a1cbec96a8219364' }
+    let(:response_file) { 'spec/assets/select_project.json' }
 
-    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
+    before { stub_request(:get, request_uri).to_return(body: File.read(response_file)) }
 
     it 'returns project details' do
       expect(subject).to be_instance_of Hash
@@ -43,5 +42,40 @@ RSpec.describe Statcounter::Projects do
         :created_at,
       )
     end
+
+    context 'when multiple ids passed' do
+      let(:project_ids) { [1, 2] }
+      let(:request_uri) { 'http://api.statcounter.com/select_project?pi=1&pi=2&vn=3&t=1466614800&u=john_brown&f=json&sha1=397509ff17b98ad6abc394d97e7d761d768c8b22' }
+      let(:response_file) { 'spec/assets/select_project_multiple.json' }
+
+      it 'returns multiple project details' do
+        expect(subject).to be_instance_of Array
+        expect(subject.size).to eq 2
+      end
+    end
+  end
+
+  describe '.create' do
+    subject do
+      described_class.create(
+        project_name: project_name,
+        url: url,
+        public_stats: public_stats,
+        credentials: default_credentials
+      )
+    end
+
+    let(:project_name) { 'Website title' }
+    let(:url) { 'http://websiteurl.com' }
+    let(:public_stats) { false }
+
+    before do
+      stub_request(:get, "http://api.statcounter.com/add_project?wt=#{project_name}&wu=#{url}&ps=0&vn=3&t=1466614800&u=john_brown&f=json&sha1=46f09a1b09f4c144508966353f406c8e109295f9")
+        .to_return(body: File.read('spec/assets/add_project.json'))
+    end
+
+    it 'creates new project' do
+      expect(subject).to include(:project_id, :security_code)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ require 'rack'
 require 'webmock/rspec'
 
 WebMock.disable_net_connect!
+WebMock::Config.instance.query_values_notation = :flat_array
 
 Dir['./spec/support/**/*.rb'].each { |f| require(f) }
 

data/spec/summary_stats_spec.rb

@@ -0,0 +1,51 @@
+RSpec.describe Statcounter::SummaryStats do
+  before { Timecop.freeze(Time.at(1466614800)) }
+
+  describe '.daily' do
+    subject do
+      described_class.daily(
+        project_ids: project_ids,
+        date_from: date_from,
+        date_to: date_to,
+        credentials: default_credentials
+      )
+    end
+
+    let(:project_ids) { 1 }
+    let(:date_from) { Date.new(2016, 6, 28) }
+    let(:date_to) { Date.new(2016, 6, 28) }
+    let(:request_uri) { 'http://api.statcounter.com/stats?s=summary&g=daily&pi=1&sd=28&sm=6&sy=2016&ed=28&em=6&ey=2016&vn=3&t=1466614800&u=john_brown&f=json&sha1=9c16ca0e1034bc8d878396b0c34a5232e971ce35' }
+    let(:response_file) { 'spec/assets/summary_stats_daily.json' }
+
+    before { stub_request(:get, request_uri).to_return(body: File.read(response_file)) }
+
+    it 'returns summery stats' do
+      expect(subject).to be_instance_of Array
+      expect(subject[0]).to include(
+        :date,
+        :page_views,
+        :unique_visits,
+        :returning_visits,
+        :first_time_visits,
+      )
+    end
+
+    context 'when multiple ids passed' do
+      let(:project_ids) { [1, 2] }
+      let(:request_uri) { 'http://api.statcounter.com/stats?s=summary&g=daily&pi=1&pi=2&sd=28&sm=6&sy=2016&ed=28&em=6&ey=2016&vn=3&t=1466614800&u=john_brown&f=json&sha1=ab0a3d2be2b3a7270ee1c2c0655e1cd7c3de818e' }
+      let(:response_file) { 'spec/assets/summary_stats_daily_multiple.json' }
+
+      it 'returns multiple project summery stats' do
+        expect(subject).to be_instance_of Hash
+        expect(subject.keys.size).to eq 2
+        expect(subject[2][0]).to include(
+          :date,
+          :page_views,
+          :unique_visits,
+          :returning_visits,
+          :first_time_visits,
+        )
+      end
+    end
+  end
+end

data/statcounter.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'webmock', '~> 2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statcounter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - "Šarūnas Kūjalis"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '2.1'
 description: 
 email:
 - sarjalis@gmail.com
@@ -132,6 +132,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -142,14 +143,20 @@ files:
 - lib/statcounter/errors.rb
 - lib/statcounter/params_encoder.rb
 - lib/statcounter/projects.rb
+- lib/statcounter/summary_stats.rb
 - lib/statcounter/version.rb
+- spec/assets/add_project.json
 - spec/assets/failure.json
 - spec/assets/select_project.json
+- spec/assets/select_project_multiple.json
+- spec/assets/summary_stats_daily.json
+- spec/assets/summary_stats_daily_multiple.json
 - spec/assets/user_projects.json
 - spec/client_spec.rb
 - spec/params_encoder_spec.rb
 - spec/projects_spec.rb
 - spec/spec_helper.rb
+- spec/summary_stats_spec.rb
 - spec/support/request_stubbing.rb
 - statcounter.gemspec
 homepage: https://github.com/ksarunas/statcounter