fabricio 1.0.0

data/fabricio.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fabricio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fabricio"
+  spec.version       = Fabricio::VERSION
+  spec.authors       = ["Egor Tolstoy"]
+  spec.email         = ["e.tolstoy@rambler-co.ru"]
+
+  spec.summary       = "A simple gem that fetches mobile application statistics from Fabric.io API."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday'
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
+end

data/lib/fabricio.rb

@@ -0,0 +1,2 @@
+require 'fabricio/version'
+require 'fabricio/client/client'

data/lib/fabricio/authorization/abstract_session_storage.rb

@@ -0,0 +1,26 @@
+require 'fabricio/authorization/session'
+
+module Fabricio
+  module Authorization
+    # A class providing an interface for implementing Fabric session storage. Subclass it to provide your own behaviour (e.g. storing session data in database)
+    class AbstractSessionStorage
+
+      # Override it with your own behavior of obtaining a [Fabricio::Authorization::Session] object
+      #
+      # @return [Fabricio::Authorization::Session]
+      def obtain_session
+        raise NotImplementedError, "Implement this method in a child class"
+      end
+
+      # Override it with your own behavior of storing a [Fabricio::Authorization::Session] object
+      def store_session(_)
+        raise NotImplementedError, "Implement this method in a child class"
+      end
+
+      # Override it with your own behavior of deleting stored [Fabricio::Authorization::Session] object
+      def reset
+        raise NotImplementedError, "Implement this method in a child class"
+      end
+    end
+  end
+end

data/lib/fabricio/authorization/authorization_client.rb

@@ -0,0 +1,122 @@
+require 'faraday'
+require 'json'
+require 'fabricio/authorization/session'
+require 'fabricio/services/organization_service'
+
+AUTH_API_URL = 'https://fabric.io/oauth/token'
+ORGANIZATION_API_URL = 'https://fabric.io/api/v2/organizations'
+
+module Fabricio
+  module Authorization
+    # A class used for user authorization.
+    class AuthorizationClient
+
+      # Returns a session object for making API requests.
+      #
+      # @param username [String]
+      # @param password [String]
+      # @param client_id [String]
+      # @param client_secret [String]
+      # @return [Fabricio::Authorization::Session]
+      def auth(username, password, client_id, client_secret)
+        perform_authorization(username, password, client_id, client_secret)
+      end
+
+      # Refreshes an expired session using refresh_token
+      #
+      # @param session [Fabricio::Authorization::Session] Expired session
+      # @return [Fabricio::Authorization::Session]
+      def refresh(session)
+        perform_refresh_token_request(session)
+      end
+
+      private
+
+      # Initiates two network requests. One for obtaining session (access and refresh tokens).
+      # Another one for obtaining organization identifier.
+      #
+      # @param username [String]
+      # @param password [String]
+      # @param client_id [String]
+      # @param client_secret [String]
+      # @raise [StandardError] Raises error if server sends incorrect response
+      # @return [Fabricio::Authorization::Session]
+      def perform_authorization(username, password, client_id, client_secret)
+        auth_data = obtain_auth_data(username, password, client_id, client_secret)
+        if auth_data['access_token'] == nil
+          raise StandardError.new("Incorrect authorization response: #{auth_data}")
+        end
+        organization_id = obtain_organization_id(auth_data)
+        Session.new(auth_data, organization_id)
+      end
+
+      # Initiates a session refresh network request
+      #
+      # @param session [Fabricio::Authorization::Session] Expired session
+      # @raise [StandardError] Raises error if server sends incorrect response
+      # @return [Fabricio::Authorization::Session]
+      def perform_refresh_token_request(session)
+        conn = Faraday.new(:url => AUTH_API_URL) do |faraday|
+          faraday.adapter Faraday.default_adapter
+        end
+
+        response = conn.post do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = {
+              'grant_type' => 'refresh_token',
+              'refresh_token' => session.refresh_token
+          }.to_json
+        end
+        result = JSON.parse(response.body)
+        if result['access_token'] == nil
+          raise StandardError.new("Incorrect authorization response: #{auth_data}")
+        end
+        Session.new(result, session.organization_id)
+      end
+
+      # Makes a request to OAuth API and obtains access and refresh tokens.
+      #
+      # @param username [String]
+      # @param password [String]
+      # @param client_id [String]
+      # @param client_secret [String]
+      # @return [Hash]
+      def obtain_auth_data(username, password, client_id, client_secret)
+        conn = Faraday.new(:url => AUTH_API_URL) do |faraday|
+          faraday.adapter Faraday.default_adapter
+        end
+
+        response = conn.post do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = {
+              'grant_type' => 'password',
+              'scope' => 'organizations apps issues features account twitter_client_apps beta software answers',
+              'username' => username,
+              'password' => password,
+              'client_id' => client_id,
+              'client_secret' => client_secret
+          }.to_json
+        end
+        JSON.parse(response.body)
+      end
+
+      # Makes a request to fetch current organization identifier.
+      # This identifier is used in most other API requests, so we store it in the session.
+      #
+      # @param auth_data [Hash] A set of authorization tokens
+      # @option options [String] :access_token OAuth access token
+      # @option options [String] :refresh_token OAuth refresh token
+      # @return [String]
+      def obtain_organization_id(auth_data)
+        conn = Faraday.new(:url => ORGANIZATION_API_URL) do |faraday|
+          faraday.adapter Faraday.default_adapter
+        end
+
+        response = conn.get do |req|
+          req.headers['Authorization'] = "Bearer #{auth_data['access_token']}"
+        end
+        JSON.parse(response.body).first['id']
+      end
+    end
+  end
+end

data/lib/fabricio/authorization/memory_session_storage.rb

@@ -0,0 +1,35 @@
+require 'fabricio/authorization/abstract_session_storage'
+
+module Fabricio
+  module Authorization
+    # The only one built-in session storage. Stores current session in memory.
+    class MemorySessionStorage < AbstractSessionStorage
+
+      # Initializes a new MemorySessionStorage object
+      #
+      # @return [Fabricio::Authorization::MemorySessionStorage]
+      def initialize
+        @session = nil
+      end
+
+      # Returns session stored in a variable
+      #
+      # @return [Fabricio::Authorization::Session]
+      def obtain_session
+        @session
+      end
+
+      # Stores session in a variable
+      #
+      # @param session [Fabricio::Authorization::MemorySessionStorage]
+      def store_session(session)
+        @session = session
+      end
+
+      # Resets current state and deletes saved session
+      def reset
+        @session = nil
+      end
+    end
+  end
+end

data/lib/fabricio/authorization/session.rb

@@ -0,0 +1,21 @@
+module Fabricio
+  module Authorization
+    # This class is a data structure that holds tokens and identifiers necessary for making API requests.
+    class Session
+      attr_reader :access_token, :refresh_token, :organization_id
+
+      # Initializes a new Session object
+      #
+      # @param attributes [Hash] Hash containing access and refresh tokens
+      # @option options [String] :access_token OAuth access token
+      # @option options [String] :refresh_token OAuth refresh token
+      # @param organization_id [String]
+      # @return [Fabricio::Authorization::Session]
+      def initialize(attributes = {}, organization_id = '')
+        @access_token = attributes['access_token']
+        @refresh_token = attributes['refresh_token']
+        @organization_id = organization_id
+      end
+    end
+  end
+end

data/lib/fabricio/client/client.rb

@@ -0,0 +1,92 @@
+require 'fabricio/models/organization'
+require 'fabricio/services/organization_service'
+require 'fabricio/services/app_service'
+require 'fabricio/services/build_service'
+require 'fabricio/authorization/authorization_client'
+require 'fabricio/authorization/session'
+require 'fabricio/authorization/memory_session_storage'
+require 'fabricio/networking/network_client'
+
+module Fabricio
+  # The main object of the gem. It's used to initiate all data requests.
+  class Client
+    # Default values for initialization parameters
+    # clientId and clientSecret are taken from Android application.
+    DEFAULT_CLIENT_ID = '2c18f8a77609ee6bbac9e53f3768fedc45fb96be0dbcb41defa706dc57d9c931'
+    DEFAULT_CLIENT_SECRET = '092ed1cdde336647b13d44178932cba10911577faf0eda894896188a7d900cc9'
+    DEFAULT_USERNAME = nil
+    DEFAULT_PASSWORD = nil
+    # In-memory session storage is used by default
+    DEFAULT_SESSION_STORAGE = Fabricio::Authorization::MemorySessionStorage.new
+
+    attr_accessor :client_id, :client_secret, :username, :password, :session_storage;
+
+    # Initializes a new Client object. You can use a block to fill all the options:
+    # client = Fabricio::Client.new do |config|
+    #   config.username = 'email@rambler.ru'
+    #   config.password = 'pa$$word'
+    # end
+    #
+    # After initializing you can query this client to get data:
+    # client.app.all
+    # client.app.active_now('app_id')
+    #
+    # @param options [Hash] Hash containing customizable options
+    # @option options [String] :client_id Client identifier. You can take it from the 'Organization' section in Fabric.io settings.
+    # @option options [String] :client_secret Client secret key. You can take it from the 'Organization' section in Fabric.io settings.
+    # @option options [String] :username Your Fabric.io username
+    # @option options [String] :password Your Fabric.io password
+    # @option options [Fabricio::Authorization::AbstractSessionStorage] :session_storage Your custom AbstractSessionStorage subclass that provides its own logic of storing session data.
+    # @return [Fabricio::Client]
+    def initialize(options =
+                       {
+                           :client_id => DEFAULT_CLIENT_ID,
+                           :client_secret => DEFAULT_CLIENT_SECRET,
+                           :username => DEFAULT_USERNAME,
+                           :password => DEFAULT_PASSWORD,
+                           :session_storage => DEFAULT_SESSION_STORAGE
+                       })
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      yield(self) if block_given?
+
+      @auth_client = Fabricio::Authorization::AuthorizationClient.new
+      session = obtain_session
+      network_client = Fabricio::Networking::NetworkClient.new(@auth_client, @session_storage)
+
+      @organization_service ||= Fabricio::Service::OrganizationService.new(session, network_client)
+      @app_service ||= Fabricio::Service::AppService.new(session, network_client)
+      @build_service ||= Fabricio::Service::BuildService.new(session, network_client)
+    end
+
+    # We use `method_missing` approach instead of explicit methods.
+    # Generally, look at the initialized services and use the first part of their names as a method.
+    # app_service -> client.app
+    #
+    # # @raise [NoMethodError] Error raised when unsupported method is called.
+    def method_missing(*args)
+      service = instance_variable_get("@#{args.first}_service")
+      return service if service
+      raise NoMethodError.new("There's no method called #{args.first} here -- please try again.", args.first)
+    end
+
+    private
+
+    # Obtains current session. If there is no cached session, it sends a request to OAuth API to get access and refresh tokens.
+    #
+    # @return [Fabricio::Authorization::Session]
+    def obtain_session
+      session = @session_storage.obtain_session
+      if !session
+        session = @auth_client.auth(@username,
+                                    @password,
+                                    @client_id,
+                                    @client_secret)
+        @session_storage.store_session(session)
+      end
+
+      session
+    end
+  end
+end

data/lib/fabricio/models/abstract_model.rb

@@ -0,0 +1,17 @@
+module Fabricio
+  module Model
+    # Defines a base class for all data models
+    class AbstractModel
+      # Plain data from the server
+      attr_accessor :json
+
+      # We use `method_missing` approach here to allow a user query any field from the original data structure sent by server.
+      def method_missing(*args)
+        method_name = args.first
+        json_value = @json[method_name.to_s]
+        return json_value if json_value
+        raise NoMethodError.new("There's no method called #{args.first} here -- please try again.", args.first)
+      end
+    end
+  end
+end

data/lib/fabricio/models/app.rb

@@ -0,0 +1,24 @@
+require 'fabricio/models/abstract_model'
+
+module Fabricio
+  module Model
+    # This model represents an application
+    class App < AbstractModel
+      attr_reader :id, :name, :bundle_id, :created_at, :platform, :icon_url
+
+      # Returns an App model object
+      #
+      # @param attributes [Hash]
+      # @return [Fabricio::Model::App]
+      def initialize(attributes)
+        @id = attributes['id']
+        @name = attributes['name']
+        @bundle_id = attributes['bundle_identifier']
+        @created_at = attributes['created_at']
+        @platform = attributes['platform']
+        @icon_url = attributes['icon_url']
+        @json = attributes
+      end
+    end
+  end
+end

data/lib/fabricio/models/build.rb

@@ -0,0 +1,23 @@
+require 'fabricio/models/abstract_model'
+
+module Fabricio
+  module Model
+    # This model represents an application build
+    class Build < AbstractModel
+      attr_reader :id, :version, :build_number, :release_notes, :distributed_at
+
+      # Returns a Build model object
+      #
+      # @param attributes [Hash]
+      # @return [Fabricio::Model::Build]
+      def initialize(attributes)
+        @id = attributes['id']
+        @version = attributes['build_version']['display_version']
+        @build_number = attributes['build_version']['build_version']
+        @release_notes = attributes['release_notes_summary']
+        @distributed_at = attributes['distributed_at']
+        @json = attributes
+      end
+    end
+  end
+end

data/lib/fabricio/models/organization.rb

@@ -0,0 +1,22 @@
+require 'fabricio/models/abstract_model'
+
+module Fabricio
+  module Model
+    # This model represents an organization
+    class Organization < AbstractModel
+      attr_reader :id, :alias, :name, :apps_counts
+
+      # Returns a Build model object
+      #
+      # @param attributes [Hash]
+      # @return [Fabricio::Model::Organization]
+      def initialize(attributes)
+        @id = attributes['id']
+        @alias = attributes['alias']
+        @name = attributes['name']
+        @apps_counts = attributes['apps_counts']
+        @json = attributes
+      end
+    end
+  end
+end

data/lib/fabricio/models/point.rb

@@ -0,0 +1,17 @@
+module Fabricio
+  module Model
+    # This model represents a data point with two fields - timestamp and value
+    class Point
+      attr_reader :date, :value
+
+      # Returns a data point with two fields - timestamp and value
+      #
+      # @param attributes [Hash]
+      # @return [Fabricio::Model::Point]
+      def initialize(attributes)
+        @date = DateTime.strptime(attributes.first.to_s,'%s')
+        @value = attributes.last
+      end
+    end
+  end
+end