appfigures 0.1.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+gem "bundler"
+gem "httparty"
+
+group :development do
+  gem "rake"
+  gem "gemcutter"
+  gem "jeweler"
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    gemcutter (0.7.1)
+    git (1.2.5)
+    httparty (0.9.0)
+      multi_json (~> 1.0)
+      multi_xml
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  gemcutter
+  httparty
+  jeweler
+  rake

data/Rakefile

@@ -0,0 +1,28 @@
+require "rake/testtask"
+require "yaml"
+require "test/unit"
+
+require "rubygems"
+require "bundler"
+Bundler.require(:default, :development)
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+begin
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "appfigures"
+    gemspec.summary = "AppFigures API"
+    gemspec.description = "AppFigures API ruby edition"
+    gemspec.email = "francis@ignition.hk"
+    gemspec.homepage = "https://github.com/siuying/appfigures"
+    gemspec.authors = ["Francis Chong"]
+  end
+  Jeweler::GemcutterTasks.new
+
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/appfigures.gemspec

@@ -0,0 +1,64 @@
+# 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 = "appfigures"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Francis Chong"]
+  s.date = "2012-09-16"
+  s.description = "AppFigures API ruby edition"
+  s.email = "francis@ignition.hk"
+  s.files = [
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "Rakefile",
+    "VERSION",
+    "appfigures.gemspec",
+    "lib/appfigures.rb",
+    "lib/appfigures/data.rb",
+    "lib/appfigures/external.rb",
+    "lib/appfigures/rank.rb",
+    "lib/appfigures/sale.rb",
+    "lib/appfigures/user.rb",
+    "test/appfigures_fixture.yml.default",
+    "test/test_data.rb",
+    "test/test_external.rb",
+    "test/test_rank.rb",
+    "test/test_sale.rb",
+    "test/test_user.rb"
+  ]
+  s.homepage = "https://github.com/siuying/appfigures"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "AppFigures 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_runtime_dependency(%q<bundler>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<gemcutter>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<gemcutter>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<gemcutter>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/lib/appfigures.rb

@@ -0,0 +1,12 @@
+path = File.expand_path(File.dirname(__FILE__))
+$:.unshift(path) unless $:.include?(path)
+
+module Appfigures
+  API_URL = "https://api.appfigures.com/v1.1"
+end
+
+require 'appfigures/user'
+require 'appfigures/data'
+require 'appfigures/sale'
+require 'appfigures/rank'
+require 'appfigures/external'

data/lib/appfigures/data.rb

@@ -0,0 +1,30 @@
+require 'httparty'
+
+module Appfigures
+  class Data
+    include HTTParty
+    base_uri API_URL
+    format :json
+    
+    def initialize(username, password)
+      @auth = {:username => username, :password => password}
+    end
+    
+    def categories
+      self.class.get("/data/categories", {:basic_auth => @auth})
+    end
+    
+    def stores
+      self.class.get("/data/stores", {:basic_auth => @auth})
+    end
+    
+    def languages
+      self.class.get("/data/languages", {:basic_auth => @auth})
+    end
+    
+    def currencies
+      self.class.get("/data/currencies", {:basic_auth => @auth})
+    end
+
+  end
+end

data/lib/appfigures/external.rb

@@ -0,0 +1,17 @@
+require 'httparty'
+
+module Appfigures
+  class External
+    include HTTParty
+    base_uri API_URL
+    format :json
+
+    def initialize(username, password)
+      @auth = {:username => username, :password => password}
+    end
+
+    def external
+      self.class.get("/external_accounts", {:basic_auth => @auth})      
+    end
+  end
+end

data/lib/appfigures/rank.rb

@@ -0,0 +1,19 @@
+require 'httparty'
+
+module Appfigures
+  class Rank
+    include HTTParty
+    base_uri API_URL
+    format :json
+    
+    def initialize(username, password)
+      @auth = {:username => username, :password => password}
+    end
+    
+    # Generating a Ranks Report
+    def ranks(app_id, granularity, start_date, end_date, options = {})
+      options.merge!({:basic_auth => @auth})
+      self.class.get("/ranks/#{app_id}/#{granularity}/#{start_date}/#{end_date}/", options)
+    end
+  end
+end

data/lib/appfigures/sale.rb

@@ -0,0 +1,53 @@
+require 'httparty'
+
+module Appfigures
+  class Sale
+    include HTTParty
+    base_uri API_URL
+    format :json
+
+    TYPE = {:DATES => "dates", :COUNTRIES => "countries", :PRODUCTS => "products", :REGION => "regions",
+      :DATES_PRODUCTS => "dates+products", :PRODUCTS_DATES => "products+dates", 
+      :COUNTRIES_PRODUCTS => "countries+products", :PRODUCTS_COUNTRIES => "products+countries",
+      :COUNTRIES_DATES => "countries+dates", :DATES_COUNTRIES => "dates+countries"
+    }
+
+    DATASOURCE = {:DAILY => "daily", :WEEKLY => "weekly", :MONTHLY => "monthly"}
+    
+    def initialize(username, password)
+      @auth = {:username => username, :password => password}
+    end
+    
+    # Generating a By App, By Country, or By Date Sales Report
+    # options[:query] can be data_source, apps or country
+    def sales(type, start_date, end_date, product_ids, options={})
+      raise ArgumentError, "Type must be one of TYPE: #{TYPE.values.join(", ")}" unless TYPE.values.index(type)
+      raise ArgumentError, "Type must be one of DATASOURCE: #{DATASOURCE.values.join(", ")}" if (options[:data_source] && !DATASOURCE.values.index(options[:data_source]))
+
+      product_ids = [product_ids] unless product_ids.is_a?(Array)
+      options.merge!({:basic_auth => @auth, :product_ids => product_ids.join(";")})
+      url = "/sales/#{type}/#{start_date}/#{end_date}/"    
+      self.class.get(url, options)
+    end
+
+    # Generating all time totals report
+    # type must be one of products, products+countries, countries, countries+products
+    def alltime_sales(type, product_ids=[], options={})
+      accept_types = %w{products products+countries countries countries+products}
+      raise ArgumentError, "Type must be one of TYPE: #{accept_types}" unless accept_types.include?(type)
+      product_ids = [product_ids] unless product_ids.is_a?(Array)
+
+      options.merge!({:basic_auth => @auth, :products => product_ids.join(";")})
+      url = "/reports/sales/#{type}"
+      self.class.get(url, options)
+    end
+
+    # Generating a By Region Sales Report
+    def region_sales(start_date, end_date, options={})
+      options.merge!({:basic_auth => @auth})
+      url = "/sales/regions/#{start_date}/#{end_date}"    
+      self.class.get(url, options)
+    end
+    
+  end
+end

data/lib/appfigures/user.rb

@@ -0,0 +1,24 @@
+require 'httparty'
+require 'uri'
+
+module Appfigures
+  class User
+    include HTTParty
+    base_uri API_URL
+    format :json
+    
+    def initialize(username, password)
+      @auth = {:username => username, :password => password}
+    end
+
+    def details(email=@auth[:username])
+      email = URI.escape(email)
+      self.class.get("/users/#{email}", {:basic_auth => @auth})
+    end
+    
+    def products(email=@auth[:username])
+      email = URI.escape(email)
+      self.class.get("/users/#{email}/products", {:basic_auth => @auth})
+    end
+  end
+end

data/test/appfigures_fixture.yml.default

@@ -0,0 +1,3 @@
+--- 
+ :username: 
+ :password: 

data/test/test_data.rb

@@ -0,0 +1,49 @@
+require "yaml"
+require "test/unit"
+
+require "rubygems"
+require "bundler"
+Bundler.require(:default)
+
+require "./lib/appfigures"
+
+class TestData < Test::Unit::TestCase
+  def setup
+    path = File.expand_path(File.dirname(__FILE__))
+    @config = YAML::load(open("#{path}/appfigures_fixture.yml"))
+
+    assert_not_nil(@config, "you must create appfigures_fixture.yml")
+    assert_not_nil(@config[:username], "you must configure username")
+    assert_not_nil(@config[:password], "you must configure password")
+
+    assert_not_equal("", @config[:username], "you must configure username")
+    assert_not_equal("", @config[:password], "you must configure password")
+
+    @data_service = Appfigures::Data.new @config[:username], @config[:password]
+  end
+
+  def test_categories
+    data = @data_service.categories
+    assert_not_nil(data)
+    assert_kind_of(Hash, data)
+  end
+
+  def test_stores
+    data = @data_service.stores
+    assert_not_nil(data)
+    assert_kind_of(Hash, data)
+  end
+
+  def test_languages
+    data = @data_service.languages
+    assert_not_nil(data)
+    assert_kind_of(Hash, data)
+  end
+
+  def test_currencies
+    data = @data_service.currencies
+    assert_not_nil(data)
+    assert_kind_of(Array, data)
+  end
+
+end

data/test/test_external.rb

@@ -0,0 +1,32 @@
+require "yaml"
+require "test/unit"
+
+require "rubygems"
+require "bundler"
+Bundler.require(:default)
+
+require "./lib/appfigures"
+
+class TestUser < Test::Unit::TestCase
+  # def test_external
+  #   path = File.expand_path(File.dirname(__FILE__))
+  #   @config = YAML::load(open("#{path}/appfigures_fixture.yml"))
+  #   @details = @user.details(@config[:username])
+
+  #   if @details["role"] == "admin"
+  #     @external = Appfigures::External.new @config[:username], @config[:password]
+  #     acct = @external.external
+  #     assert_not_nil(acct)
+  #     assert_kind_of(Hash, acct)
+  #     assert(acct.size > 0, "account should have at least one itc_account")
+
+  #     first_acct = acct[acct.keys.first]
+  #     assert_kind_of(Hash, first_acct)
+  #     assert_not_nil(first_acct["account_id"])
+  #     assert_not_nil(first_acct["id"])
+  #   else
+  #     assert_equal(acct.parsed_response["additional"], "You do not have permission to access this resource.")
+  #   end
+
+  # end
+end

data/test/test_rank.rb

@@ -0,0 +1,44 @@
+require "yaml"
+require "test/unit"
+
+require "rubygems"
+require "bundler"
+Bundler.require(:default)
+
+require "./lib/appfigures"
+require 'uri'
+class TestRank < Test::Unit::TestCase
+  def setup
+    path = File.expand_path(File.dirname(__FILE__))
+    @config = YAML::load(open("#{path}/appfigures_fixture.yml"))
+
+    assert_not_nil(@config, "you must create appfigures_fixture.yml")
+    assert_not_nil(@config[:username], "you must configure username")
+    assert_not_nil(@config[:password], "you must configure password")
+
+    assert_not_equal("", @config[:username], "you must configure username")
+    assert_not_equal("", @config[:password], "you must configure password")
+
+    @user = Appfigures::User.new @config[:username], @config[:password]
+    @rank = Appfigures::Rank.new @config[:username], @config[:password]
+    
+    @day_minutes_one = (Time.now - 24*60*60).strftime("%Y-%m-%d")
+    @day_minutes_two = (Time.now - 2*24*60*60).strftime("%Y-%m-%d")
+  end
+
+  def test_ranks
+    apps = @user.products(@config[:username])
+    first_app = apps[apps.keys.first]
+    assert_kind_of(Hash, first_app)
+
+    ranks = @rank.ranks(first_app["id"], "daily", @day_minutes_two, @day_minutes_one)
+    assert_not_nil(ranks, "ranks report should be okay")
+  end
+  
+  def test_ranks_complex
+    apps = @user.products(@config[:username])
+    apps = apps.keys[0..10].join(";")
+    ranks = @rank.ranks(apps, "daily", @day_minutes_two, @day_minutes_one)
+    assert_not_nil(ranks, "ranks report should be okay")
+  end
+end

data/test/test_sale.rb

@@ -0,0 +1,51 @@
+require "yaml"
+require "test/unit"
+
+require "rubygems"
+require "bundler"
+Bundler.require(:default)
+
+require "./lib/appfigures"
+
+class TestSale < Test::Unit::TestCase
+  def setup
+    path = File.expand_path(File.dirname(__FILE__))
+    @config = YAML::load(open("#{path}/appfigures_fixture.yml"))
+
+    assert_not_nil(@config, "you must create appfigures_fixture.yml")
+    assert_not_nil(@config[:username], "you must configure username")
+    assert_not_nil(@config[:password], "you must configure password")
+
+    assert_not_equal("", @config[:username], "you must configure username")
+    assert_not_equal("", @config[:password], "you must configure password")
+
+    @sale = Appfigures::Sale.new @config[:username], @config[:password]
+    @user = Appfigures::User.new @config[:username], @config[:password]
+    
+    @day_minutes_one = (Time.now - 24*60*60).strftime("%Y-%m-%d")
+    @day_minutes_two = (Time.now - 2*24*60*60).strftime("%Y-%m-%d")
+
+    @apps = @user.products(@config[:username])
+    @first_app = @apps[@apps.keys.first]
+    assert_kind_of(Hash, @first_app)
+
+  end
+
+  def test_sales
+    one_app_report = @sale.sales("dates", @day_minutes_two, @day_minutes_one, [@first_app["id"]])
+    assert_not_nil(one_app_report, "sales report (one app only) should be okay")
+  end
+
+  def test_alltime
+    alltime_report = @sale.alltime_sales("products", @first_app["id"])
+    assert_not_nil(alltime_report, "all time report should be okay")
+    assert_kind_of(Hash, alltime_report)
+  end
+
+  def test_region
+    alltime_report = @sale.region_sales(@day_minutes_two, @day_minutes_one)
+    assert_not_nil(alltime_report, "all time report should be okay")
+    assert_kind_of(Hash, alltime_report)
+  end
+  
+end

data/test/test_user.rb

@@ -0,0 +1,51 @@
+require "yaml"
+require "test/unit"
+
+require "rubygems"
+require "bundler"
+Bundler.require(:default)
+
+require "./lib/appfigures"
+
+class TestUser < Test::Unit::TestCase
+  def setup
+    path = File.expand_path(File.dirname(__FILE__))
+    @config = YAML::load(open("#{path}/appfigures_fixture.yml"))
+    
+    assert_not_nil(@config, "you must create appfigures_fixture.yml")
+    assert_not_nil(@config[:username], "you must configure username")
+    assert_not_nil(@config[:password], "you must configure password")
+
+    assert_not_equal("", @config[:username], "you must configure username")
+    assert_not_equal("", @config[:password], "you must configure password")
+
+    @user = Appfigures::User.new @config[:username], @config[:password]
+  end
+
+  def test_details
+    details = @user.details(@config[:username])
+    assert_not_nil(details)
+
+    assert_not_nil(details["region"])
+    assert_not_nil(details["id"])
+    assert_not_nil(details["account"])
+    assert_not_nil(details["products"])
+
+    assert_kind_of(Hash, details["account"])
+    assert_kind_of(Array, details["products"])
+  end
+  
+  def test_apps
+    apps = @user.products(@config[:username])
+    assert_not_nil(apps)
+    assert_kind_of(Hash, apps)
+
+    assert(apps.size > 0, "account should have at least one app")
+    first_app = apps[apps.keys.first]
+    assert_kind_of(Hash, first_app)
+    assert_kind_of(Array, first_app["in_apps"])
+    assert_not_nil(first_app["name"])
+    assert_not_nil(first_app["id"])
+  end
+  
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: appfigures
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Francis Chong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70099329990640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70099329990640
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70099329990060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70099329990060
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70099329989400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70099329989400
+- !ruby/object:Gem::Dependency
+  name: gemcutter
+  requirement: &70099329988920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70099329988920
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70099329988360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70099329988360
+description: AppFigures API ruby edition
+email: francis@ignition.hk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- VERSION
+- appfigures.gemspec
+- lib/appfigures.rb
+- lib/appfigures/data.rb
+- lib/appfigures/external.rb
+- lib/appfigures/rank.rb
+- lib/appfigures/sale.rb
+- lib/appfigures/user.rb
+- test/appfigures_fixture.yml.default
+- test/test_data.rb
+- test/test_external.rb
+- test/test_rank.rb
+- test/test_sale.rb
+- test/test_user.rb
+homepage: https://github.com/siuying/appfigures
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2930390160613838490
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: AppFigures API
+test_files: []