yandex_metric 0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 bskaplou
+
+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.rdoc

@@ -0,0 +1,53 @@
+= yandex_metric
+
+Simple wrapper over Yandex Metric REST API.
+
+== Methods
+
+Yandex Metric API => Ruby
+
+GET /counters => get_counters
+
+POST /counter/{id}/filters => post_counter_filters
+
+DELETE /counter/{id}/grant/{user_login} => delete_counter_grant
+
+All methods are taking the only argument which is hash.
+{something} in request path will be raplaced with args['something'].
+
+== Examples
+
+ ym = YM::YandexMetric.new({
+   :username => username,
+   :password => password,
+   :client_id => client_id,
+   :client_secret => client_secret,
+ })
+
+ cid = ym.get_counters['counters'][0]['id']
+ puts ym.get_counter_goals({'id' => cid})
+ yesterday = (Time.new - 86400).strftime '%Y%m%d'
+ today = Time.new.strftime '%Y%m%d'
+ p = {
+   'id' => cid,
+   'date1' => yesterday,
+   'date2' => today,
+   'group' => 'day'
+ }
+ puts ym.get_stat_traffic_summary(p)
+
+== Contributing to yandex_metric
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 bskaplou. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "yandex_metric"
+  gem.homepage = "http://github.com/bskaplou/yandex_metric"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple API for Yandex Metric manipulations through Yandex Metric API}
+  gem.description = %Q{YandexMetric hides OAuth from user and converts Yandex Metric REST methods into ruby methods}
+  gem.email = "bskaplou@gmail.com"
+  gem.authors = ["bskaplou"]
+  gem.version = File.read 'VERSION'
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yandex_metric #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1

data/lib/yandex_metric.rb

@@ -0,0 +1,134 @@
+require 'net/https'
+require 'net/http'
+require 'cgi'
+require 'json'
+
+module YM
+  SSL_PORT = 443
+  TIMEOUT = 50
+
+  class Client
+    def self.encode_params prms
+      prms.inject ('') { |acc, (k, v)|
+        acc + CGI::escape(k) + '=' + CGI::escape(v.to_s) + '&'
+      }
+    end
+  
+    def self.default_args
+      {:port => SSL_PORT,
+       :ssl => true,
+       :timeout => TIMEOUT}
+    end
+  
+    def self.client args = {}
+      args = default_args.merge args 
+      cli = Net::HTTP.new args[:host], args[:port]
+      cli.use_ssl = args[:ssl]
+      #Not enough percise timeout but will not block execution
+      cli.read_timeout = cli.open_timeout = cli.ssl_timeout = args[:timeout]
+      cli
+    end
+  
+    def self.result res
+      raise res.value unless res.instance_of? Net::HTTPOK
+      res.body
+    end
+  
+    def self.get args = {}
+      qpath = args[:path] + '?' + encode_params(args[:params])
+      result(client(args).get2 qpath, args[:headers])
+    end
+  
+    def self.post args = {}
+      result(client(args).post2 args[:path], encode_params(args[:params]))
+    end
+  
+    def self.put args = {}
+      '{"error" : "not implemented yet"}'
+    end
+  
+    def self.delete args = {}
+      '{"error" : "not implemented yet"}'
+    end
+  end
+  
+  class YandexMetric
+    OAUTH_HOST = 'oauth.yandex.ru'
+    OAUTH_PORT = SSL_PORT
+    OAUTH_PATH = '/token'
+    API_HOST = 'api-metrika.yandex.ru'
+    API_PORT = SSL_PORT
+    SSL = true
+  
+    def default_options
+      {:timeout => TIMEOUT}
+    end
+  
+    def default_headers
+      {'Accept' => 'application/x-yametrika+json'}
+    end
+  
+    attr_reader :options
+    def initialize options = {}
+      @options = default_options.merge options
+    end
+  
+    def init_token
+      params = {'grant_type' => 'password'}
+      [:username, :password, :client_id, :client_secret].each do |key|
+        options.has_key? key or raise "#{key} is not defined"
+        params[key.to_s] = options[key]
+      end
+      args = {
+        :host => OAUTH_HOST,
+        :port => OAUTH_PORT,
+        :ssl => SSL,
+        :path => OAUTH_PATH,
+        :params => params,
+        :timeout => options[:timeout]
+      }
+      JSON.parse(Client.post args)['access_token']
+    end
+  
+    def get_token
+      @token ||= init_token
+    end
+  
+    def generic_method method, path, params
+      headers = default_headers.merge({'Authorization' => ("OAuth " + get_token)})
+      args = {
+        :host => API_HOST,
+        :port => API_PORT,
+        :ssl => SSL,
+        :path => path,
+        :params => params,
+        :headers => headers,
+        :timeout => options[:timeout]
+      }
+      JSON.parse(Client.send method, args)
+    end
+  
+    def self.method_name method, path
+        #/path/{id}/param => path_param
+        method_tail = path[1..-1].gsub(/\/{[a-zA-Z0-9_]+}/, '').gsub(/\//, '_')
+        #'GET /path/{id}/param' => 'get_path_param'
+        method.downcase + '_' + method_tail
+    end
+  
+    def self.api_method description, path, methods, param_desc = ''
+      #path sometimes starts with '/' but not always
+      path = '/' + path unless path[0] == '/'
+      methods.split(' ').each do |m|
+        define_method method_name(m, path) do |args = {}|
+          #/path/{id}/param => /path/id_value/param
+          real_path = path.gsub(/\{[a-zA-Z0-9_]+\}/) {|id|
+            args.delete(id[1..-2])
+          } 
+          generic_method m.downcase.to_sym, real_path, args
+        end
+      end
+    end
+  end
+end  
+
+load 'yandex_metric_methods.rb'

data/lib/yandex_metric_methods.rb

@@ -0,0 +1,46 @@
+module YM
+YandexMetric.api_method 'Список счетчиков','/counters','GET POST','-'
+YandexMetric.api_method 'Счетчик','/counter/{id}','GET PUT DELETE','id  ― числовой идентификатор счетчика.'
+YandexMetric.api_method 'Список целей счетчика','/counter/{id}/goals','GET POST','-'
+YandexMetric.api_method 'Цель счетчика','/counter/{id}/goal/{goal_id}','GET PUT DELETE','goal_id  ― числовой идентификатор цели.'
+YandexMetric.api_method 'Список фильтров счетчика','/counter/{id}/filters','GET POST','filter_id  ― числовой идентификатор фильтра.'
+YandexMetric.api_method 'Фильтр счетчика','/counter/{id}/filter/{filter_id}','GET PUT DELETE','filter_id  ― числовой идентификатор фильтра.'
+YandexMetric.api_method 'Список операций счетчика','/counter/{id}/operations','GET POST','-'
+YandexMetric.api_method 'Операция счетчика','/counter/{id}/operation/{operation_id}','GET PUT DELETE','operation_id  ― числовой идентификатор операции.'
+YandexMetric.api_method 'Список гостевых доступов счетчика','/counter/{id}/grants','GET POST','-'
+YandexMetric.api_method 'Право доступа к счетчику','/counter/{id}/grant/{user_login}','GET PUT DELETE','user_login  ― логин пользователя, которому выдан гостевой доступ. Для публичной статистики вместо логина пользователя указывается «0».'
+YandexMetric.api_method 'Список собственных представителей','/delegates','GET PUT POST','-'
+YandexMetric.api_method 'Представитель','/delegate/{user_login}','DELETE','user_login  ― логин пользователя, которому выдан полный доступ.'
+YandexMetric.api_method 'Список аккаунтов (прав на представительство)','/accounts','GET PUT','-'
+YandexMetric.api_method 'Аккаунт','/account/{user_login}','DELETE','user_login  ― логин владельца аккаунта.'
+YandexMetric.api_method 'Посещаемость','stat/traffic/summary','GET'
+YandexMetric.api_method 'Вовлечение','stat/traffic/deepness','GET'
+YandexMetric.api_method 'По времени суток','stat/traffic/hourly','GET'
+YandexMetric.api_method 'Нагрузка на сайт','stat/traffic/load','GET'
+YandexMetric.api_method 'Сводка','stat/sources/summary','GET'
+YandexMetric.api_method 'Сайты','stat/sources/sites','GET'
+YandexMetric.api_method 'Поисковые системы','stat/sources/search_engines','GET'
+YandexMetric.api_method 'Поисковые фразы','stat/sources/phrases','GET'
+YandexMetric.api_method 'Рекламные системы','stat/sources/marketing','GET'
+YandexMetric.api_method 'Директ ― сводка','stat/sources/direct/summary','GET'
+YandexMetric.api_method 'Директ ― площадки','stat/sources/direct/platforms','GET'
+YandexMetric.api_method 'Директ ― регионы','stat/sources/direct/regions','GET'
+YandexMetric.api_method 'Метки','stat/sources/tags','GET'
+YandexMetric.api_method 'Популярное содержание','stat/content/popular','GET'
+YandexMetric.api_method 'Страницы входа','stat/content/entrance','GET'
+YandexMetric.api_method 'Страницы выхода','stat/content/exit','GET'
+YandexMetric.api_method 'Заголовки страниц','stat/content/titles','GET'
+YandexMetric.api_method 'Параметры URL','stat/content/url_param','GET'
+YandexMetric.api_method 'Отчет по Странам мира','stat/geo','GET'
+YandexMetric.api_method 'Пол и возраст','stat/demography/age_gender','GET'
+YandexMetric.api_method 'Половозрастная структура','stat/demography/structure','GET'
+YandexMetric.api_method 'Браузеры','stat/tech/browsers','GET'
+YandexMetric.api_method 'Операционные системы','stat/tech/os','GET'
+YandexMetric.api_method 'Разрешения дисплеев','stat/tech/display','GET'
+YandexMetric.api_method 'Мобильные устройства','stat/tech/mobile','GET'
+YandexMetric.api_method 'Версии Flash','stat/tech/flash','GET'
+YandexMetric.api_method 'Версии Silverlight','stat/tech/silverlight','GET'
+YandexMetric.api_method 'Версии .NET','stat/tech/dotnet','GET'
+YandexMetric.api_method 'Наличие Java','stat/tech/java','GET'
+YandexMetric.api_method 'Наличие Cookies','stat/tech/cookies','GET'
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'yandex_metric'
+
+class Test::Unit::TestCase
+end

data/test/test_yandex_metric.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestYandexMetric < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    #flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/yandex_metric.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "yandex_metric"
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["bskaplou"]
+  s.date = "2011-11-14"
+  s.description = "YandexMetric hides OAuth from user and converts Yandex Metric REST methods into ruby methods"
+  s.email = "bskaplou@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/yandex_metric.rb",
+    "lib/yandex_metric_methods.rb",
+    "test/helper.rb",
+    "test/test_yandex_metric.rb",
+    "yandex_metric.gemspec"
+  ]
+  s.homepage = "http://github.com/bskaplou/yandex_metric"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Simple API for Yandex Metric manipulations through Yandex Metric API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: yandex_metric
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.1"
+platform: ruby
+authors: 
+- bskaplou
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: YandexMetric hides OAuth from user and converts Yandex Metric REST methods into ruby methods
+email: bskaplou@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/yandex_metric.rb
+- lib/yandex_metric_methods.rb
+- test/helper.rb
+- test/test_yandex_metric.rb
+- yandex_metric.gemspec
+homepage: http://github.com/bskaplou/yandex_metric
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 664816113
+      segments: 
+      - 0
+      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.10
+signing_key: 
+specification_version: 3
+summary: Simple API for Yandex Metric manipulations through Yandex Metric API
+test_files: []
+