fryfro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d555272b9b18003cce7e838bd1b201c98b3d6a0
+  data.tar.gz: 631db63c4c74d0fcb39fc259621e991278dddc82
+SHA512:
+  metadata.gz: 3eaa7b22870fae1cc7c05d30d61e897b9b1d9c9515df34effab2376a50ea5a896848f3ef2874f84fda718c31c717d4e01884004acffc50d0418ed75622720ce6
+  data.tar.gz: 2cfcabd1ab720a7b7ec889913c07a89517ba0a995f1c2cc7f78182c496f43ac4ce5f388291df6213e4c589ac8ef67921b6cca59e101264c861a1672434bf45a7

data/.document

@@ -0,0 +1,3 @@
+lib/**/*.rb
+-
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+!doc/fryfro.png
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--order random
+--color
+-f d

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Max Riveiro
+
+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,33 @@
+# Fryfro
+
+Fryfro is a Flurry API client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fryfro'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fryfro
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## Copyright
+
+Copyright (c) 2013 Max Riveiro. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+YARD::Rake::YardocTask.new
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/fryfro.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fryfro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fryfro'
+  spec.version       = Fryfro::VERSION
+  spec.authors       = ['Max Riveiro']
+  spec.email         = ['kavu13@gmail.com']
+  spec.description   = 'Fryfro provides an interface for the Flurry API.'
+  spec.summary       = 'Fryfro is a Flurry API client.'
+  spec.homepage      = 'https://github.com/kavu/fryfro'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.11.0'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'bundler',     '~> 1.3'
+  spec.add_development_dependency 'rspec',       '~> 2.13'
+  spec.add_development_dependency 'rspec-mocks', '~> 2.13'
+  spec.add_development_dependency 'yard',        '~> 0.8.5'
+end

data/lib/fryfro.rb

@@ -0,0 +1,27 @@
+require 'fryfro/version'
+
+require 'fryfro/endpoint'
+require 'fryfro/app_info'
+require 'fryfro/app_metrics'
+require 'fryfro/events_metrics'
+require 'fryfro/raw_data'
+
+require 'fryfro/app'
+
+module Fryfro
+  class << self
+    def all_applications_info_raw(opts = {})
+      AppInfo[:get_all_applications].(opts[:access_code])['applications']
+    end
+
+    def all_applications(opts = {})
+      raw = all_applications_info_raw(opts)['application']
+
+      raw.reduce([]) do |apps, app|
+        apps << App.new(key: app['apiKey'], access_code: opts[:access_code],
+                        name: app['name'], platform: app['platform'],
+                        created_at: app['createdDate'])
+      end
+    end
+  end
+end

data/lib/fryfro/app.rb

@@ -0,0 +1,64 @@
+module Fryfro
+  class App
+    attr_reader :key, :access_code, :name, :platform, :created_at
+
+    def initialize(opts = {})
+      # Mandatory
+      @access_code = opts[:access_code] or raise ArgumentError, 'Provide an apiAccessCode'
+      @key         = opts[:key]         or raise ArgumentError, 'Provide an apiKey'
+
+      # Optional
+      @name       = opts[:name]
+      @platform   = opts[:platform]
+      @created_at = opts[:created_at]
+    end
+
+    def info
+      AppInfo[:get_application].(@access_code, @key)['appInfo']
+    end
+
+    def metric(metric, opts = {})
+      raise ArgumentError, 'Provide an eventName' unless metric
+      check_required_dates(opts)
+      AppMetrics[metric].(@access_code, @key, opts)['appMetrics']
+    end
+
+    def events(opts = {})
+      check_required_dates(opts)
+      EventMetrics[:summary].(@access_code, @key, opts)['eventMetrics']
+    end
+
+    def event(opts = {})
+      raise ArgumentError, 'Provide an eventName' unless opts[:event_name] || opts['eventName']
+      check_required_dates(opts)
+      EventMetrics[:event].(@access_code, @key, opts)['eventMetrics']
+    end
+
+    def raw_data(opts = {})
+      check_params_overlap(opts)
+      time_params?(opts) ? check_required_times(opts) : check_required_dates(opts)
+      RawData[:events].(@access_code, @key, opts)
+    end
+
+    private
+      def check_required_dates(opts)
+        raise ArgumentError, 'Provide an startDate' unless opts[:start_date] || opts['startDate']
+        raise ArgumentError, 'Provide an endDate'   unless opts[:end_date]   || opts['endDate']
+      end
+
+      def check_required_times(opts)
+        raise ArgumentError, 'Provide an startTime' unless opts[:start_time] || opts['startTime']
+        raise ArgumentError, 'Provide an endTime'   unless opts[:end_time]   || opts['endTime']
+      end
+
+      def check_params_overlap(opts)
+        start_param = (opts[:start_date] || opts['startDate']) && (opts[:start_time] || opts['startTime'])
+        end_param   = (opts[:end_date]   || opts['endDate'])   && (opts[:end_time]   || opts['endTime'])
+        raise ArgumentError, 'Provide a startDate/endDate or a startTime/endTime only' if start_param || end_param
+      end
+
+      def time_params?(opts)
+        opts[:start_time] || opts['startTime'] || opts[:end_time] || opts['endTime']
+      end
+  end
+end

data/lib/fryfro/app_info.rb

@@ -0,0 +1,10 @@
+# http://support.flurry.com/index.php?title=API/Code/AppInfo
+module Fryfro
+  class AppInfo < Endpoint
+    base_uri 'http://api.flurry.com/appInfo'
+
+    class << self
+      alias_method :camelize, :camelize_key
+    end
+  end
+end

data/lib/fryfro/app_metrics.rb

@@ -0,0 +1,6 @@
+# http://support.flurry.com/index.php?title=API/Code
+module Fryfro
+  class AppMetrics < Endpoint
+    base_uri 'http://api.flurry.com/appMetrics'
+  end
+end

data/lib/fryfro/endpoint.rb

@@ -0,0 +1,37 @@
+require 'httparty'
+
+module Fryfro
+  class Endpoint
+    include HTTParty
+
+    headers 'Accept' => 'application/xml'
+
+    debug_output $stdout if ENV['DEBUG']
+
+    class << self
+      def [](metric)
+        Proc.new do |code, key, opts = {}|
+          hash = { api_access_code: code }
+          hash[:api_key] = key if key
+          hash.merge!(opts)
+
+          get("/#{camelize(metric)}?#{queryize(hash)}")
+        end
+      end
+
+      def queryize(hash)
+        camelized_hash = Hash[hash.map { |k, v| [camelize_key(k), v] }]
+        URI.encode_www_form(camelized_hash)
+      end
+
+      def camelize(sym)
+        sym.to_s.split('_').map { |w| w.capitalize }.join
+      end
+
+      def camelize_key(sym)
+        parts = sym.to_s.split('_')
+        parts[0] + parts[1..-1].map { |w| w.capitalize }.join
+      end
+    end
+  end
+end

data/lib/fryfro/events_metrics.rb

@@ -0,0 +1,6 @@
+# http://support.flurry.com/index.php?title=API/Code/EventMetrics
+module Fryfro
+  class EventMetrics < Endpoint
+    base_uri 'http://api.flurry.com/eventMetrics'
+  end
+end

data/lib/fryfro/raw_data.rb

@@ -0,0 +1,11 @@
+# http://support.flurry.com/index.php?title=API/Code/RawData
+# The RawData API allows you to request a dump of raw session data for one of your applications over
+# a specified time period. Note that this API requires special permissions so please contact flurry
+# support (support@flurry.com) or talk to your Flurry Account Manager for more information.
+
+# TODO: Implement the Request Report feature, and the publish
+# module Fryfro
+#   class RawData < Endpoint
+#     base_uri 'http://api.flurry.com/rawData'
+#   end
+# end

data/lib/fryfro/version.rb

@@ -0,0 +1,3 @@
+module Fryfro
+  VERSION = '0.1.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'rspec/mocks'
+require 'fyrfro'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: fryfro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Max Riveiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+description: Fryfro provides an interface for the Flurry API.
+email:
+- kavu13@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/fryfro.png
+- fryfro.gemspec
+- lib/fryfro.rb
+- lib/fryfro/app.rb
+- lib/fryfro/app_info.rb
+- lib/fryfro/app_metrics.rb
+- lib/fryfro/endpoint.rb
+- lib/fryfro/events_metrics.rb
+- lib/fryfro/raw_data.rb
+- lib/fryfro/version.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kavu/fryfro
+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.0.1
+signing_key: 
+specification_version: 4
+summary: Fryfro is a Flurry API client.
+test_files:
+- spec/spec_helper.rb
+has_rdoc: