appfigures_client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d43e23d5e5e65cdecc38232d8e4177f926c3b750
+  data.tar.gz: 7b68172629d704319da396bc8eeee7732c81569b
+SHA512:
+  metadata.gz: dc29ba35452f334dd159eab029d9e09b024586410cb6235c851330b7b6c595c15dfeb9e2941f1aa008efa765bfc72c3cad76a6989b5e8f7d73a41d81b8e9cba3
+  data.tar.gz: 55d50f9fec06043c14463c09a4cca28f17d6b0612caf7773327e1b56f25063b7ad7d01f99a308e2c968442d6f230664887d44bb5a59520d800c66e14a24146fb

data/Gemfile

@@ -0,0 +1,15 @@
+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 "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,88 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    builder (3.2.2)
+    coderay (1.1.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.2)
+    highline (1.7.2)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    multi_json (1.11.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  pry
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Aleksey Dmitriev
+
+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,53 @@
+#AppFigures API Client
+
+A Ruby wrapper for appfigures.com API
+##Installation
+
+In your Gemfile you need to add the `appfigures_client` gem:
+```ruby
+gem 'appfigures_client'
+```
+And then run the bundler and restart your server to make the files available through the pipeline:
+```console
+$ bundle install
+```
+Or install it separately:
+
+```console
+$ gem install appfigures_client
+```
+##Usage
+For more information read http://docs.appfigures.com/
+
+```ruby
+require 'appfigures_client'
+api = AppfiguresClient.init(USERNAME, PASSWORD, CLIENT_KEY)
+api.products.search(options={}) # return products list
+api.products.get(id) # return product by id
+api.products.all(store = nil) # returns products list from store
+api.sales.search(options = {}) # return sales report
+api.sales.search_by_regions(options = {}) # return sales report by regions
+api.ads.search(options = {}) # returns ads report
+api.reviews.search(options = {}) # returns reviews 
+api.reviews.counts(options = {}) # returns review counts
+api.ranks.search(options = {}) # returns ranks report
+api.ranks.snapshot(options = {}) # returns ranks report
+
+```
+
+
+## Contributing
+ 
+* 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) 2015 Aleksey Dmitriev. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# 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://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "appfigures_client"
+  gem.homepage = "http://github.com/addmitriev/appfigures_client"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "ya-est@bk.ru"
+  gem.authors = ["Aleksey Dmitriev"]
+  # 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
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+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 = "appfigures_client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/appfigures_client.gemspec

@@ -0,0 +1,43 @@
+
+# -*- encoding: utf-8 -*-
+$:.push('lib')
+require 'appfigures_client/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'appfigures_client'
+  s.version  = AppfiguresClient::VERSION.dup
+  s.date     = '2015-06-26'
+  s.summary  = 'API client for AppFigures'
+  s.email    = 'alexey@ioncloud.ru'
+  s.homepage = 'http://github.com/addmitriev/appfigures_client'
+  s.authors  = ['Aleksey Dmitriev']
+  
+  s.description = <<-EOF
+    A Ruby wrapper for appfigures.com API
+EOF
+  
+  dependencies = [
+    # Examples:
+    # [:runtime,     "rack",  "~> 1.1"],
+    # [:development, "rspec", "~> 2.1"],
+  ]
+  
+  s.files         = Dir['**/*']
+  s.test_files    = Dir['test/**/*'] + Dir['spec/**/*']
+  s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  
+  
+  ## Make sure you can build the gem on older versions of RubyGems too:
+  s.rubygems_version = "2.4.6"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.specification_version = 3 if s.respond_to? :specification_version
+  
+  dependencies.each do |type, name, version|
+    if s.respond_to?("add_#{type}_dependency")
+      s.send("add_#{type}_dependency", name, version)
+    else
+      s.add_dependency(name, version)
+    end
+  end
+end

data/config/routes.yml

@@ -0,0 +1,27 @@
+products:
+ default: 'products/'
+ mine: 'products/mine/'
+ search: 'products/search/'
+report:
+  sales:
+    default: 'reports/sales/'
+    region: 'reports/sales/regions/'
+  ads: 'reports/ads/'
+ranks:
+  default: 'ranks/'
+  snapshots: 'ranks/snapshots/'
+featured: 'featured/'
+reviews:
+  default: 'reviews/'
+  count: 'reviews/count/'
+events: 'events/'
+archive: 'archive/'
+users: 'users/'
+external_accounts: 'external_accounts/'
+data:
+  categories: 'data/categories/'
+  countries: 'data/countries/'
+  languages: 'data/languages/'
+  currencies: 'data/currencies/'
+  stores: 'data/stores/'
+usage: 'usage/'

data/lib/appfigures_client.rb

@@ -0,0 +1,25 @@
+require 'appfigures_client/net/request'
+require 'appfigures_client/api'
+require 'appfigures_client/endpoints/endpoint'
+require 'appfigures_client/endpoints/data'
+require 'appfigures_client/endpoints/products'
+require 'appfigures_client/endpoints/sales'
+require 'appfigures_client/endpoints/ads'
+require 'appfigures_client/endpoints/ranks'
+require 'appfigures_client/endpoints/reviews'
+require 'net/http'
+require 'json'
+
+module AppfiguresClient
+
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
+
+  def self.init(username, password, client_key)
+
+    Api.new({username: username, password: password, client_key: client_key})
+
+  end
+
+end

data/lib/appfigures_client/api.rb

@@ -0,0 +1,52 @@
+module AppfiguresClient
+  class Api
+
+
+    URL = 'https://api.appfigures.com/v2/'
+
+
+    def initialize(options)
+      @request ||= Net::Request.new(options)
+
+      data = @request.make
+
+      if data[:status].to_i == 200
+        self
+      else
+        raise data[:message]
+      end
+
+      @routes = YAML::load(File.open("#{AppfiguresClient.root}/config/routes.yml")).with_indifferent_access
+
+    end
+
+    def data
+      @data ||= AppfiguresClient::Endpoints::Data.new(self, @routes[:data])
+    end
+
+    def products
+      @products ||= AppfiguresClient::Endpoints::Products.new(self, @routes[:products])
+    end
+
+    def sales
+      @sales ||= AppfiguresClient::Endpoints::Sales.new(self, @routes[:report][:sales])
+    end
+
+    def ads
+      @ads ||= AppfiguresClient::Endpoints::Ads.new(self, @routes[:report][:ads])
+    end
+
+    def ranks
+      @ranks ||= AppfiguresClient::Endpoints::Ranks.new(self, @routes[:ranks])
+    end
+
+    def reviews
+      @ranks ||= AppfiguresClient::Endpoints::Reviews.new(self, @routes[:reviews])
+    end
+
+    def request
+      @request
+    end
+
+  end
+end

data/lib/appfigures_client/endpoints/ads.rb

@@ -0,0 +1,13 @@
+module AppfiguresClient
+    module Endpoints
+      class Ads < Endpoint
+
+
+        def search(options={})
+          path = @routes[:default]
+          @request.make path
+        end
+
+      end
+    end
+  end

data/lib/appfigures_client/endpoints/data.rb

@@ -0,0 +1,42 @@
+module AppfiguresClient
+    module Endpoints
+      class Data < Endpoint
+
+        def initialize(api, routes)
+          super api, routes
+          @data = {}
+        end
+
+        def list(param, param2 = nil)
+          if param2
+            @data[param] ||= {}
+            @data[param][param2] ||= @request.make @routes[param][param2]
+          else
+            @data[param] ||= @request.make @routes[param]
+          end
+        end
+
+        def categories
+          list(:categories)
+        end
+
+        def countries(store = nil)
+          list(:countries, store)
+        end
+
+        def languages
+          list(:languages)
+        end
+
+        def currencies
+          list(:currencies)
+        end
+
+        def stores
+          list(:stores)
+        end
+
+      end
+    end
+  end
+

data/lib/appfigures_client/endpoints/endpoint.rb

@@ -0,0 +1,11 @@
+module AppfiguresClient
+  module Endpoints
+    class Endpoint
+      def initialize(api, routes)
+        @api = api
+        @request = api.request
+        @routes = routes
+      end
+    end
+  end
+end

data/lib/appfigures_client/endpoints/products.rb

@@ -0,0 +1,35 @@
+module AppfiguresClient
+    module Endpoints
+      class Products < Endpoint
+
+        FILTERS = %w(mac ios google amazon)
+
+        def get(id)
+          path = @routes[:default] + id.to_s
+          @request.make path
+        end
+
+        def search(options={})
+          path = @routes[:search]
+
+          raise '"term" option is required' unless options[:term].present?
+
+          if options[:options].present? && options[:options][:filter].present?
+            raise 'Wrong "filter" param' unless options[:options][:filter].in? FILTERS
+          end
+
+          @request.make path + options[:term], options[:options]
+        end
+
+        def all(store = nil)
+          path = @routes[:mine]
+          options = nil
+          if store && @api.data.stores[store].present?
+            options = {store: store}
+          end
+          @request.make path, options
+        end
+
+      end
+    end
+  end

data/lib/appfigures_client/endpoints/ranks.rb

@@ -0,0 +1,39 @@
+module AppfiguresClient
+    module Endpoints
+      class Ranks < Endpoint
+
+
+        def search(options={})
+          raise '"product_ids" option is required' unless options[:product_ids].present?
+          raise '"granularity" option is required' unless options[:granularity].present?
+          raise '"start_date" option is required' unless options[:start_date].present?
+          raise '"end_date" option is required' unless options[:end_date].present?
+
+          path = "#{@routes[:default]}#{product_ids(options[:product_ids])}"
+          path +="/#{options[:granularity]}/#{options[:start_date]}/#{options[:end_date]}"
+
+          @request.make path, options[:options]
+
+        end
+
+        def snapshots(options = {})
+          raise '"time" option is required' unless options[:time].present?
+          raise '"country" option is required' unless options[:country].present?
+          raise '"category" option is required' unless options[:category].present?
+          raise '"subcategory" option is required' unless options[:subcategory].present?
+
+          path = "#{@routes[:snapshots]}#{options[:time]}"
+          path +="/#{options[:country]}/#{options[:category]}/#{options[:subcategory]}"
+
+          @request.make path, options[:options]
+        end
+
+        private
+
+        def product_ids(product_ids)
+           product_ids.kind_of?(Array) ? product_ids.join(';') : product_ids
+        end
+
+      end
+    end
+  end

data/lib/appfigures_client/endpoints/reviews.rb

@@ -0,0 +1,19 @@
+module AppfiguresClient
+  module Endpoints
+    class Reviews < Endpoint
+
+
+      def search(options={})
+        path = @routes[:default]
+        @request.make path, options
+      end
+
+      def counts(options={})
+        path = @routes[:count]
+        @request.make path, options
+      end
+
+    end
+
+  end
+end

data/lib/appfigures_client/endpoints/sales.rb

@@ -0,0 +1,25 @@
+module AppfiguresClient
+    module Endpoints
+      class Sales < Endpoint
+
+
+        def search(options={})
+          path = @routes[:default]
+
+          if options[:map].present?
+            path = path + options[:map]
+          end
+
+          @request.make path, options[:options]
+
+        end
+
+        def search_by_regions(options={})
+          path = @routes[:regions]
+
+          @request.make path, options
+        end
+
+      end
+    end
+  end

data/lib/appfigures_client/net/request.rb

@@ -0,0 +1,34 @@
+module AppfiguresClient
+  module Net
+    class Request
+
+      def initialize(options)
+        @username = options[:username]
+        @password = options[:password]
+        @client_key = options[:client_key]
+      end
+
+      def make(path = '', params = {})
+        uri = ::URI.parse(Api::URL + path)
+        http = ::Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        request_params = params ? '?' + parameterize(params) : ''
+
+        req = ::Net::HTTP::Get.new(uri.path + request_params)
+        req.basic_auth @username, @password
+        req['X-CLIENT-KEY'] = @client_key
+
+        response = http.request req
+        parsed = JSON.parse(response.body)
+        parsed.kind_of?(Array) ? parsed.collect {|hash| hash.with_indifferent_access } : parsed.with_indifferent_access
+      end
+
+      private
+
+      def parameterize(params)
+        URI.escape(params.collect { |k, v| "#{k}=#{v}" }.join('&'))
+      end
+
+    end
+  end
+end

data/lib/appfigures_client/version.rb

@@ -0,0 +1,3 @@
+module AppfiguresClient
+  VERSION = '0.0.2'
+end

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+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 'appfigures_client'
+
+class Test::Unit::TestCase
+end

data/test/test_appfigures_client.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAppfiguresClient < 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

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: appfigures_client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Aleksey Dmitriev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-26 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      A Ruby wrapper for appfigures.com API
+email: alexey@ioncloud.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- appfigures_client-0.0.1.gem
+- appfigures_client.gemspec
+- config/routes.yml
+- lib/appfigures_client.rb
+- lib/appfigures_client/api.rb
+- lib/appfigures_client/endpoints/ads.rb
+- lib/appfigures_client/endpoints/data.rb
+- lib/appfigures_client/endpoints/endpoint.rb
+- lib/appfigures_client/endpoints/products.rb
+- lib/appfigures_client/endpoints/ranks.rb
+- lib/appfigures_client/endpoints/reviews.rb
+- lib/appfigures_client/endpoints/sales.rb
+- lib/appfigures_client/net/request.rb
+- lib/appfigures_client/version.rb
+- test/helper.rb
+- test/test_appfigures_client.rb
+homepage: http://github.com/addmitriev/appfigures_client
+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.6
+signing_key: 
+specification_version: 3
+summary: API client for AppFigures
+test_files:
+- test/helper.rb
+- test/test_appfigures_client.rb