flurry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aab9d43586ace9b91f12ef33efe629a925b6965615760ae91302574330bba5e6
+  data.tar.gz: aad2af4110cd6fa68efaad1cd5c9e8ca886d2248684d1bc1c404c755c3ac5363
+SHA512:
+  metadata.gz: e515c93beb93060111cb0b87355b08de981d688f258017a697a5c1591ed7950e5c6aa923431c25f41113807d7dcc43ead3d2ab2ada24155beed0518abfdd0af1
+  data.tar.gz: 1d7858cb57f6a9e14a7d3484ee9eec409565777a881d270eb33c6debba90afdd487b0a7e39571ad6ae22d8bec0346590b11530a90a0cc46dbb8af101b2f2660f

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Roger Bagué Martí
+
+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/lib/flurry/configuration.rb

@@ -0,0 +1,11 @@
+module Flurry
+  # Contains all the configuration for the gem
+  class Configuration
+    attr_accessor :token, :time_zone
+
+    def initialize
+      @token = nil
+      @time_zone = nil
+    end
+  end
+end

data/lib/flurry/helper.rb

@@ -0,0 +1,24 @@
+require 'date'
+
+module Flurry
+  # Helper methods used across the library
+  module Helper
+    private
+
+    def camelize(string)
+      string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { $&.downcase }
+      string.gsub(%r{(?:_|(/))([a-z\d]*)}) do
+        "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
+      end.gsub('/', '::')
+    end
+
+    def datetime?(value)
+      value.respond_to?(:strftime)
+    end
+
+    def tomorrow(date)
+      tomorrow = Date.parse(date.to_s) if date.is_a?(Time)
+      (tomorrow || date) + 1
+    end
+  end
+end

data/lib/flurry/request.rb

@@ -0,0 +1,96 @@
+require 'httparty'
+require 'flurry/helper'
+
+module Flurry
+  class Request # :nodoc:
+    include HTTParty
+    include Helper
+
+    base_uri 'https://api-metrics.flurry.com/public/v1/data'
+
+    def initialize(table, group_by)
+      raise ArgumentError, 'table must be non nil' if table.nil?
+
+      @table = table
+      @grain = group_by || :day
+    end
+
+    def showing(**dimensions)
+      dup.tap { |it| it.dimensions = clean_dimensions(dimensions || {}) }
+    end
+
+    def select(*metrics)
+      metrics = metrics.flatten.reject(&:nil?) || []
+      raise Flurry::Error, 'at least one metric has to be provided' if metrics.empty?
+
+      dup.tap { |it| it.metrics = metrics }
+    end
+
+    def between(start, finish = nil, format: '%Y-%m-%d')
+      raise Flurry::Error, 'at least start time has to be provided' unless start
+      raise ArgumentError, 'start must be a Time/Date/DateTime' unless datetime?(start)
+      raise ArgumentError, 'finish must be a Time/Date/DateTime' if finish && !datetime?(finish)
+
+      finish = (finish || tomorrow(start)).strftime(format)
+      start = start.strftime(format)
+
+      dup.tap { |it| it.range = [start, finish] }
+    end
+
+    def fetch
+      self.class.get(full_path).response
+    end
+
+    protected
+
+    attr_writer :table, :grain, :dimensions, :metrics, :range
+
+    private
+
+    def clean_dimensions(**dimens)
+      dimens.each_with_object({}) do |(key, val), h|
+        new_value = [val] unless val.is_a? Array
+        new_value ||= val
+        new_value.map! { |v| camelize(v.to_s) unless v.nil? }
+        h[camelize(key.to_s)] = new_value
+      end
+    end
+
+    def base_partial_path
+      "/#{camelize(@table.to_s)}/#{@grain}"
+    end
+
+    def dimensions_partial_path
+      partial = ''.tap do |path|
+        @dimensions.each do |dimension, fields|
+          path << "/#{dimension}"
+          path << ";show=#{fields.join(',')}" if fields.any?
+        end
+      end if @dimensions
+
+      partial || ''
+    end
+
+    def metrics_partial_path
+      '&metrics=' + @metrics.map do |metric|
+        camelize(metric.to_s) unless metric.nil?
+      end.join(',')
+    end
+
+    def time_range_partial_path
+      "&dateTime=#{@range.join('/')}"
+    end
+
+    def full_path
+      ''.tap do |path|
+        path << base_partial_path
+        path << dimensions_partial_path
+        path << '?'
+        path << 'token=' + Flurry.configuration.token
+        path << '&timeZone=' + Flurry.configuration.time_zone if Flurry.configuration.time_zone
+        path << metrics_partial_path
+        path << time_range_partial_path
+      end
+    end
+  end
+end

data/lib/flurry/version.rb

@@ -0,0 +1,3 @@
+module Flurry
+  VERSION = '0.1.0'.freeze
+end

data/lib/flurry.rb

@@ -0,0 +1,25 @@
+require 'flurry/version'
+require 'flurry/configuration'
+require 'flurry/request'
+
+module Flurry
+  class Error < StandardError; end
+
+  class << self
+    # Start a Flurry configuration block in an initializer.
+    #
+    # Used to provide the Flurry API access token
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  def self.from(table, group_by = nil)
+    raise Flurry::Error, 'a valid token must be provided before any call' if configuration.token.nil?
+    Request.new(table, group_by)
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: flurry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roger Bagué
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-04 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.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+    Flurry provides easy access to Flurry Analytics Reporting API
+    with a friendly API.
+email:
+- rogerbague@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/flurry.rb
+- lib/flurry/configuration.rb
+- lib/flurry/helper.rb
+- lib/flurry/request.rb
+- lib/flurry/version.rb
+homepage: https://github.com/rbague/flurry
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: A wrapper around Flurry Analytics Reporting API
+test_files: []