app_figures 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08cffe76a59b4b33cd2a48ab466438cebf100379
+  data.tar.gz: a6caf6be062e96b10fa7181a4ef56e22ccc77328
+SHA512:
+  metadata.gz: d67fe2ef22c50e677ecd44e95618dac2baed4a3c1a5dc9e7b3741a0c565cc179af1a2ee10a55479cd991195eff4801c309acf1b9ca8bd1e3c947a57ea144a326
+  data.tar.gz: c55591f65732d5134438a050d53d9ded06fc0c6e7cbbb07bf5cb74c470edd48b89d4a2887e2e04afdce48c3a558de1aa652fb0514eb9f58e291048e39987770c

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+.DS_Store
+mkmf.log

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.1
+  - 1.9.3
+  - jruby-head
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development, :test do
+  gem 'oj' unless defined?(JRUBY_VERSION)
+end
+
+group :development do
+  gem 'gem-release', require: false
+  gem 'pry', require: false
+end
+
+group :test, :rake do
+  gem 'bundler'
+end
+
+group :rake do
+  gem 'rake'
+end
+
+group :test do
+  gem 'minitest', require: false
+  gem 'minitest-spec-context', require: false
+  gem 'minitest-reporters', require: false
+  gem 'mocha', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Shidel
+
+MIT License
+
+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,157 @@
+app_figures
+===========
+
+[![Build Status](https://travis-ci.org/styleseek/app_figures.svg?branch=master)](https://travis-ci.org/styleseek/app_figures)[![Code Climate](https://codeclimate.com/github/styleseek/app_figures.png)](https://codeclimate.com/github/styleseek/app_figures)
+
+
+Simple API Client for [AppFigures.com](http://appfigures.com/), supports pulling in products and sales from AppFigures with Basic Auth. Send us a pull request and help us expand the support of API this gem covers
+
+If this gem doesn't meet your needs, there is an older [appfigures api client](http://rubygems.org/gems/appfigures) that may be better suited, but only supports the AppFigures API `v1`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'app_figures'
+
+And then execute:
+
+    $ bundle
+
+Or install it globally:
+
+    $ gem install app_figures
+
+## Usage
+
+### Register your app with AppFigures.com
+
+This gem currently only supports Basic Auth, but still requires you to register your app to get a client key.
+
+1. While logged into AppFigures, visit: https://appfigures.com/developers/keys
+2. Click 'Create a New Client', give it a name, and set your permissions. This gem needs at least `READ` access to "Product Meta Data" and "Private Data".
+3. Click 'Make me an app' to complete the registration and get yoru client key.
+
+### Configuration
+
+To configure the gem to access the API, you will need the client key you created above, and the username and password of a user on your AppFigures account.
+
+The username and password needs to be combined and base64 encoded before being passed to the gem. You can do that easily in the terminal:
+
+    $ echo -n "username:password" | base64
+
+This is covered in more detail in the [AppFigures API documentation](http://docs.appfigures.com/api/reference/v2/authentication).
+
+#### ENV variables
+
+The preferred method of configuring authentication for the gem is through environment variables:
+
+Two `ENV` vars are needed:
+
+  - `APPFIGURES_CLIENT_KEY` (your client key)
+  - `APPFIGURES_CREDENTIALS` (base 64 encoded username:password)
+
+Once those are set, you can instantiate a new client:
+
+```ruby
+AppFigures.client
+# => #<AppFigures::Client:0x007fc5c304e8f0 @client_key="...", @credentials="...">
+```
+#### Options Hash
+
+You can also pass `AppFigures.client` your authentication values in the options hash:
+
+```ruby
+AppFigures.client(client_key: 'abc', credentials: 'xyz')
+# => #<AppFigures::Client:0x007fc5c304e8f0 @client_key="abc", @credentials="xyz">
+```
+
+Passed in options will take precedence over the ENV vars.
+
+
+### Making Requests
+
+#### Products
+
+```list_products``` will give all registered products (can be filtered by store) see: http://docs.appfigures.com/products#Listing_all_of_your_products
+
+```product_by_id``` will give one registered product by it's appfigures id see: http://docs.appfigures.com/products#Getting_a_product_by_its_id
+
+Examples:
+
+```ruby
+client = AppFigures.client
+my_products = client.list_products
+=> {"397821346"=>
+  {"id"=>397821346,
+   "name"=>"Example app",
+   "developer"=>"Example App maker",
+   "icon"=>
+    "http:/icon.com/icon.png",
+   "vendor_identifier"=>"763309467",
+   "ref_no"=>7634478,
+   "sku"=>"EXAMPLE",
+   "package_name"=>nil,
+   "store_id"=>1,
+   "store"=>"apple",
+   "storefront"=>"apple:ios",
+   "release_date"=>"2013-14-02T05:00:00-05:00",
+   "added_date"=>"2013-14-03T20:17:23-05:00",
+   "updated_date"=>"2014-08-20T02:52:22-04:00",
+   "version"=>"3.0.1",
+   "source"=>
+    {"external_account_id"=>76435,
+     "added_timestamp"=>"2014-06-06T00:00:00",
+     "active"=>true,
+     "hidden"=>false,
+     "type"=>"own"},
+   "type"=>"app",
+   "devices"=>["Handheld", "Tablet"],
+   "children"=>[],
+   "features"=>[],
+   "parent_id"=>nil,
+   "price"=>{"currency"=>"USD", "price"=>"0.00"}},
+ "400718594467"=>
+  {"id"=>40071854567,
+   "name"=>"EXAMPLE app 2",
+   "developer"=>"Example app maker",...}}
+   
+   
+   
+one_product = client.product_by_id("397821346")
+=> {"id"=>397821346,
+ "name"=>"Example app",
+ "developer"=>"Example app maker",
+ "icon"=>
+  "http:/icon.com/icon.png"
+ "vendor_identifier"=>"763309467",
+ "ref_no"=>7634478,
+ "sku"=>"Example",....}
+
+```
+
+#### Sales
+
+Example:
+
+```ruby
+client = AppFigures.client
+sales = client.sales
+=> {"downloads"=>4589,
+ "updates"=>11234,
+ "returns"=>0,
+ "net_downloads"=>4589,
+ "promos"=>0,
+ "revenue"=>"0.00",
+ "edu_downloads"=>0,
+ "gifts"=>0,
+ "gift_redemptions"=>0}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/styleseek/app_figures/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+# environment
+ENV['RACK_ENV'] ||= 'development'
+
+# load path
+lib_path = File.expand_path('../lib', __FILE__)
+($:.unshift lib_path) unless ($:.include? lib_path)
+
+# spinning up the FTL drive
+Bundler.require(:default, :rake, ENV['RACK_ENV'])
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+# prepare to jump
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.pattern = "spec/**/*_spec.rb"
+end
+task :default => [:test]

data/app_figures.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'app_figures/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "app_figures"
+  spec.version       = AppFigures::VERSION
+  spec.authors       = ['StyleSeek Engineering']
+  spec.email         = ['engineering@styleseek.com']
+  spec.summary       = %q{Simple API Client for AppFigures.com}
+  spec.description   = %q{Simple API Client for AppFigures.com, supports pulling in products and sales from AppFigures with Basic Auth.}
+  spec.homepage      = "https://github.com/styleseek/app_figures"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = nil
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.13"
+  spec.add_dependency "multi_json", "~> 1.10"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+ENV['RACK_ENV'] ||= 'development'
+# load path
+lib_path = File.expand_path('../../lib', __FILE__)
+($:.unshift lib_path) unless ($:.include? lib_path)
+
+# require farm
+require 'bundler'
+Bundler.require(:default, ENV['RACK_ENV'])
+require 'pry'
+require 'app_figures'
+
+# fire up the ftl drive
+Pry.start

data/lib/app_figures/client.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+module AppFigures
+  class Client
+    include HTTParty
+    base_uri 'https://api.appfigures.com/v2'
+
+    attr_reader :client_key, :credentials
+
+    def initialize(options = {})
+      options ||= {}
+      options = default_options.merge(options)
+
+      @client_key = options[:client_key]
+      @credentials = options[:credentials]
+
+      check_configuration!
+    end
+
+    def sales(query = {})
+      response = self.class.get('/sales', query: query, headers: authorization_headers)
+      handle_request_status(response)
+    end
+
+    def product_by_id(id)
+      response = self.class.get("/products/#{id}", headers: authorization_headers)
+      handle_request_status(response)
+    end
+
+    def list_products(store = nil)
+      if store
+        query = {store: store}
+      else
+        query = {}
+      end
+
+      response = self.class.get("/products/mine", query: query, headers: authorization_headers)
+      handle_request_status(response)
+    end
+
+    private
+
+    def authorization_headers
+      {
+        'X-Client-Key' => client_key,
+        'Authorization' => "Basic #{credentials}"
+      }
+    end
+
+    def default_options
+      {
+        client_key:  ENV['APPFIGURES_CLIENT_KEY'],
+        credentials: ENV['APPFIGURES_CREDENTIALS']
+      }
+    end
+
+    def check_configuration!
+      if client_key.nil? or client_key == ''
+        raise Errors::AuthorizationError.new('client_key is required.')
+      end
+
+      if credentials.nil? or credentials == ''
+        raise Errors::AuthorizationError.new('credentials is required.')
+      end
+    end
+
+    def handle_request_status(response)
+      case response.code
+        when 404
+          raise Errors::NotFound.new
+        when 500...600
+          raise Errors::BadRequest.new(response.code)
+        else
+          response
+      end
+    end
+  end
+end

data/lib/app_figures/errors.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module AppFigures
+  module Errors
+    class AuthorizationError < StandardError
+      attr_reader :message
+      def initialize(message)
+        @message = message
+      end
+    end
+
+    class NotFound < StandardError
+      attr_reader :code
+      def initialize
+        @code = 404
+      end
+    end
+
+    class BadRequest < StandardError
+      attr_reader :code
+
+      def initialize(code)
+        @code = code
+      end
+    end
+  end
+end

data/lib/app_figures/version.rb

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

data/lib/app_figures.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'httparty'
+require 'app_figures/version'
+require 'app_figures/client'
+require 'app_figures/errors'
+
+module AppFigures
+  def self.client(options = {})
+    Client.new(options)
+  end
+end

data/spec/app_figures/app_figures_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe AppFigures do
+  context '.client with option hash' do
+
+    before do
+      @appfigures = AppFigures.client({client_key: 'your client key', credentials:'base 64 encoded username:password' })
+    end
+
+    it 'can configure a client key' do
+      @appfigures.client_key.must_equal 'your client key'
+    end
+
+    it 'can configure credentials' do
+      @appfigures.credentials.must_equal 'base 64 encoded username:password'
+    end
+
+  end
+
+  context '.client with env vars' do
+    before do
+        ENV['APPFIGURES_CLIENT_KEY'] = 'abc'
+        ENV['APPFIGURES_CREDENTIALS'] = '123'
+    end
+
+    after do
+      ENV.delete('APPFIGURES_CLIENT_KEY')
+      ENV.delete('APPFIGURES_CREDENTIALS')
+    end
+
+    it 'inits a new client object with ENV vars' do
+      AppFigures.client.must_be_instance_of AppFigures::Client
+    end
+  end
+end

data/spec/app_figures/client_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe AppFigures::Client do
+  context '.new with env vars' do
+
+    before do
+      ENV['APPFIGURES_CLIENT_KEY'] = 'abc'
+      ENV['APPFIGURES_CREDENTIALS'] = '123'
+    end
+
+    after do
+      ENV.delete('APPFIGURES_CLIENT_KEY')
+      ENV.delete('APPFIGURES_CREDENTIALS')
+    end
+
+    it 'takes an option hash' do
+      client = AppFigures::Client.new({client_key: 'my client key', credentials: "my credentials"})
+      client.client_key.wont_be_nil
+      client.credentials.wont_be_nil
+    end
+
+    it 'defualts to env vars if no block or options hash is given' do
+      client = AppFigures::Client.new
+      client.client_key.wont_be_nil
+      client.credentials.wont_be_nil
+    end
+  end
+
+  context '.new without env vars' do
+    it 'throws error if credentials or client key is nil' do
+      Proc.new{ AppFigures::Client.new }.must_raise AppFigures::Errors::AuthorizationError
+    end
+  end
+
+  it 'has a base url' do
+    client = AppFigures::Client.new(client_key: 'my client key', credentials: "my credentials")
+    client.class.base_uri.must_equal 'https://api.appfigures.com/v2'
+  end
+end

data/spec/app_figures/products_spec.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe AppFigures::Client do
+  context 'products' do
+
+    before do
+      @client = AppFigures::Client.new({client_key: 'exampleclientkey', credentials: 'examplebase64encodedstring'})
+      @headers = { 'X-Client-Key' => @client.client_key, 'Authorization' => "Basic #{@client.credentials}" }
+    end
+
+    it 'can get a product by id' do
+      @client.class.expects(:get)
+      .with('/products/212135374', headers: @headers)
+      .returns(Response.ok)
+
+      @client.product_by_id(212135374)
+    end
+
+    it 'can list all products' do
+      @client.class.expects(:get)
+      .with('/products/mine', query: {}, headers: @headers )
+      .returns(Response.ok)
+
+      @client.list_products
+    end
+
+    it 'can list all products scoped to a store' do
+      @client.class.expects(:get)
+      .with('/products/mine', query: {store: 'apple'}, headers: @headers )
+      .returns(Response.ok)
+
+      @client.list_products('apple')
+    end
+
+
+    it 'throws a not found error for a 404 code' do
+      @client.class.expects(:get)
+      .with('/products/mine', query: {store: 'google_play'}, headers: @headers )
+      .returns(Response.not_found)
+
+       Proc.new{ @client.list_products('google_play') }.must_raise AppFigures::Errors::NotFound
+    end
+
+    it 'throws a bad request error for a 500 to 600 code' do
+      @client.class.expects(:get)
+      .with('/products/mine', query: {store: 'amazon'}, headers: @headers)
+      .returns(Response.bad)
+
+       Proc.new{ @client.list_products('amazon') }.must_raise AppFigures::Errors::BadRequest
+    end
+  end
+end

data/spec/app_figures/sales_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe AppFigures::Client do
+  context '.sales' do
+    before do
+      @client = AppFigures::Client.new(client_key: 'exampleclientkey', credentials: 'examplebase64encodedstring')
+      @headers = { 'X-Client-Key' => @client.client_key, 'Authorization' => "Basic #{@client.credentials}" }
+    end
+
+    it 'requests results' do
+      options = { query: {}, headers: @headers }
+      @client.class.expects(:get).with('/sales', options).returns(Response.ok)
+      @client.sales
+    end
+
+    it 'requests results with a start date' do
+      options = { query: { start_date: '2014-01-01' }, headers: @headers }
+      @client.class.expects(:get).with('/sales', options).returns(Response.ok)
+      @client.sales(start_date: '2014-01-01')
+    end
+
+    it 'raises error for bad request' do
+      options = { query: { start_date: '2013-01-01' }, headers: @headers }
+      @client.class.expects(:get).with('/sales', options).returns(Response.bad)
+      Proc.new { @client.sales(start_date: '2013-01-01') }.must_raise AppFigures::Errors::BadRequest
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+# bootstrap the environment
+ENV['RACK_ENV'] = 'test'
+lib_path = File.expand_path('../lib', __FILE__)
+($:.unshift lib_path) unless ($:.include? lib_path)
+
+# require dependencies
+require 'bundler'
+Bundler.setup(:default, ENV['RACK_ENV'])
+
+#require gem
+require 'app_figures'
+
+#require BDD Stack
+require 'mocha/mini_test'
+require 'minitest/autorun'
+require "minitest-spec-context"
+require 'minitest/reporters'
+
+
+module Response
+  #code from httparty
+
+  def self.last_modified
+    Date.new(2010, 1, 15).to_s
+  end
+
+  def self.content_length
+    '1024'
+  end
+
+  def self.request_object
+    HTTParty::Request.new Net::HTTP::Get, '/'
+  end
+
+  def self.parsed_response
+    lambda { {"foo" => "bar"} }
+  end
+
+  def self.bad
+    response_object = Net::HTTPOK.new('1.1', 500, 'NOT FOUND')
+    response_object.stubs(:body).returns("{foo:'bar'}")
+    response_object['last-modified'] = last_modified
+    response_object['content-length'] = content_length
+    response = HTTParty::Response.new(request_object, response_object, parsed_response)
+  end
+
+  def self.not_found
+    response_object = Net::HTTPOK.new('1.1', 404, 'NOT FOUND')
+    response_object.stubs(:body).returns("{foo:'bar'}")
+    response_object['last-modified'] = last_modified
+    response_object['content-length'] = content_length
+    response = HTTParty::Response.new(request_object, response_object, parsed_response)
+
+  end
+
+  def self.ok
+    response_object = Net::HTTPOK.new('1.1', 200, 'OK')
+    response_object.stubs(:body).returns("{foo:'bar'}")
+    response_object['last-modified'] = last_modified
+    response_object['content-length'] = content_length
+    response = HTTParty::Response.new(request_object, response_object, parsed_response)
+  end
+
+end
+
+#  all systems go
+MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: app_figures
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- StyleSeek Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: Simple API Client for AppFigures.com, supports pulling in products and
+  sales from AppFigures with Basic Auth.
+email:
+- engineering@styleseek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app_figures.gemspec
+- bin/console
+- lib/app_figures.rb
+- lib/app_figures/client.rb
+- lib/app_figures/errors.rb
+- lib/app_figures/version.rb
+- spec/app_figures/app_figures_spec.rb
+- spec/app_figures/client_spec.rb
+- spec/app_figures/products_spec.rb
+- spec/app_figures/sales_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/styleseek/app_figures
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple API Client for AppFigures.com
+test_files:
+- spec/app_figures/app_figures_spec.rb
+- spec/app_figures/client_spec.rb
+- spec/app_figures/products_spec.rb
+- spec/app_figures/sales_spec.rb
+- spec/spec_helper.rb