rescuetime 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26e48ef7046be4852886e8a2f7854e4b328002d3
-  data.tar.gz: 1e7201de9e2011839b55755a52e0e0f3224cb710
+  metadata.gz: 9e7a807f2b3aaf12d096fc4547b5990436cc661c
+  data.tar.gz: ef7cc81293795d19b560d028f51b752c85038261
 SHA512:
-  metadata.gz: 4ee47235b7780e6bbd9e54673722c9a6e44eaadc1eddc2621002943641648bf2fc275deca712c5696435e40025f2e4755a89301c0d07d3b8d47ef08b885f9f4b
-  data.tar.gz: 59127d45d97eb47d2ff464410835d724e64be87867f9500e0a847abb40187432369dbe3c6aa5c56dd8d6e05fa00e18fd92ed68afb2b138de234bda2ae5c908a6
+  metadata.gz: 55a8baa378221aef8445cac82fa16240fdfaf10dc296acb4f63316e13a9d4c02cfad3489627dcdc452e4e4553d79afe9b1fb7c44eecb75f8dc083a6227c5dbf3
+  data.tar.gz: 75df0025d9269632ae9659eb7f4dabac97b6047a248ba86cc11cf079ad09ad222bfc5c22b3904ea2f9c58adf394a6a633fe878e35665765157f715e3f2f867db

data/.travis.yml

@@ -2,7 +2,6 @@ cache: bundler
 
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1
   - 2.2

data/CONTRIBUTING.md

@@ -29,13 +29,7 @@ You should be able to run the test specs now:
 bundle exec rake
 ```
 
-Some great ways to contribute include:
-- fixing [bugs](https://github.com/leesharma/rescuetime/issues?q=is%3Aopen+is%3Aissue+-label%3A%22in+progress%22+label%3Abug)
-- adding [features listed in our current milestone](https://github.com/leesharma/rescuetime/issues?q=is%3Aopen+is%3Aissue+-label%3A%22in+progress%22) (filter by milestone)
-- adding/improving documentation, comments, etc.
-- refactoring existing code
-
-Check our [issue tracker](https://github.com/leesharma/rescuetime/issues) for more ideas.
+This is a very small project, so if you are interested in contributing, it will be easiest if you contact me first.
 
 ## Standards
 
@@ -43,6 +37,13 @@ rescuetime uses RSpec for testing along with VCR and WebMock for mocking HTTP re
 
 Be careful not to commit sensitive information (API keys, OAuth credentials, etc.) to public repositories!
 
+### Comment Tags
+
+* TODO
+* FIXME
+* OPTIMIZE
+* REVIEW
+
 ## Questions
 
-Have any questions? Feel free to send me (@leesharma) a message!
+Have any questions? Post on the github repo at leesharma/rescuetime.

data/README.md

@@ -20,7 +20,8 @@ For more information about RescueTime, visit [the RescueTime homepage](https://w
 * [Installation](#installation)
 * [Usage](#usage)
    * [Prerequisites](#prerequisites)
-   * [Getting Started](#getting-started)
+   * [In a Nutshell](#in-a-nutshell) (skip to here if you want to see the syntax)
+   * [Finding Answers (Documentation)](#finding-answers-documentation)
    * [Defaults](#defaults)
    * [Rescuetime Exceptions](#rescuetime-exceptions)
 * [Development](https://github.com/leesharma/rescuetime/wiki/Development) ([section](#development))
@@ -54,9 +55,7 @@ Ensure that you are using a [supported ruby version](https://github.com/leesharm
 
 In order to use access your RescueTime data, you will need an API key. If you do not already have a key, visit the [API key management page](https://www.rescuetime.com/anapi/manage).
 
-### Getting Started
-
-Using the rescuetime gem is simple. Here is some example code using the rescuetime gem (a full feature list can be found [here](https://github.com/leesharma/rescuetime/wiki#full-specs):
+### In a Nutshell
 
 ```ruby
 require 'rescuetime'
@@ -65,19 +64,88 @@ require 'rescuetime'
 @client.api_key?            #=> true
 @client.valid_credentials?  #=> true
 
-@client.activities          # Returns a list of activities, ordered by "rank"
-@client.productivity        # Returns a productivity report
-@client.efficiency          # Returns an efficiency report, ordered by "time"
-
-@client.activities.class    # => Array
-@client.activities[0].class # => Hash
-
-@client.efficiency( from: '2015-03-20',     # returns weekly efficiency report between March 20th and 
-                    to: '2015-04-20' ,      #   April 20th of 2015 by member in csv format
-                    interval: 'week', 
-                    format: 'csv' )
+# Rescuetime uses lazy evaluation, so until you either manipulate the collection
+# or explicitly call for it (with #all), it will remain in the Rescuetime::Collection
+# format. 
+@client.overview.class      #=> Rescuetime::Collection
+@client.overview.all.class  #=> Array
+@client.overview.map {...}  #=> Array
+
+@client.overview      # Returns an overview report, defaulting to "rank" order
+@client.categories    # Returns a catigorical report, defaulting to "rank" order
+@client.activities    # Returns a list of activities, defaulting to "rank" order
+@client.productivity  # Returns a productivity report, defaulting to "rank" order
+@client.efficiency    # Returns an efficiency report, defaulting to "time order"
+
+##
+# Date Range (:date, :frome, :to)
+# -------------------------------
+# Defaults:
+#   If nothing is provided, defaults to current day (since 00:00)
+#   If :from is provided, defaults :to to current day
+#
+# Valid date formats:
+#   - "YYYY-MM-DD"    - "MM-DD-YYYY"    - "DD/MM"
+#   - Object#strftime
+@client.overview                      # Fetches results from today
+@client.overview.date('2014-12-31')   # Fetches results from Dec 31, 2014.
+@client.overview.from('2015-01-01').to('2015-02-01')         
+@client.overview.from('2015-04-01')            
+       
+
+##
+# Report Order (:order_by)
+# ------------------------
+# Defaults:
+#   Efficiency defaults to chronological order; everything else defaults to "rank" order
+#
+# You can order_by: 
+#   :rank, :time, or :member (note: efficiency can't be sorted by :rank)
+#
+# When ordering by time, default interval is 1 hour.
+# Options include:
+#   :minute (5-minute chunks), :hour, :day, :week, :month
+@client.efficiency    # Defaults to :time
+@client.productivity  # Defaults to :rank
+                                          
+@client.productivity.order_by(:rank)       
+@client.productivity.order_by(:time)      
+@client.productivity.order_by(:member)    
+                                          
+@client.productivity.order_by(:time)  # Defaults to :hour
+@client.productivity.order_by(:time, interval: :minute)     
+@client.productivity.order_by(:time, interval: :hour)       
+@client.productivity.order_by(:time, interval: :day)        
+@client.productivity.order_by(:time, interval: :week)
+@client.productivity.order_by(:time, interval: :month)
+
+##
+# Name Restrictions (:where)
+# --------------------------
+# Fetches results where name is an exact match
+# The following reports can be limited by name:
+#   :activities, :categories, :overview
+#
+# For activities, you can also limit by specific document title
+#   (ex. document 'rails/rails' for activity 'github.com')
+#   Try the query sans document for a list of valid options
+#
+# Names must be exact matches.
+@client.activities.where(name: 'github.com')    
+@client.categories.where(name: 'Intelligence')  
+@client.overview.where(name: 'Utilities')       
+@client.activities.where(name: 'github.com', document: 'vcr/vcr')                   
+
+##
+# Formatting options (:csv, :array)
+# ---------------------------------
+@client.efficiency                  # Default return type is Array<Hash>
+@client.efficiency.format(:cvs)     # Returns a CSV
+@client.efficiency.format(:array)   # Returns Array<Hash>
 ```
 
+### Finding Answers (Documentation)
+
 For more details, please see [official gem documentation](http://www.rubydoc.info/gems/rescuetime/0.1.0) or [read the wiki](https://github.com/leesharma/rescuetime/wiki). 
 
 ### Defaults
@@ -86,10 +154,9 @@ The `Rescuetime::Client#activities` action has the following defaults:
 
 ```ruby
 
-{ by:               'rank'
-  time_interval:    'hour'
-  date:             <TODAY>
-  detail:           'activity' }
+{ order_by:         'rank'
+  interval:         'hour'
+  date:             <TODAY> }
 
 ```
 
@@ -97,8 +164,25 @@ The `Rescuetime::Client#activities` action has the following defaults:
 
 There are a number of exceptions that extend from the custom Rescuetime::Error class:
 
-* **Rescuetime::MissingCredentials** is raised when a request is attempted by a client with no credentials. Try setting credentials with `@client.api_key=<YOUR_API_KEY>`.
-* **Rescuetime::InvalidCredentials** is raised when a request is attempted by a client with invalid credentials. Double-check your API key and fix your client with `@client.api_key=<VALID_API_KEY>`.
+* * **Rescuetime::MissingCredentialsError** is raised when a request is attempted by a client with no credentials. Try setting credentials with `@client.api_key = <YOUR_API_KEY>`.
+* **Rescuetime::InvalidCredentialsError** is raised when a request is attempted by a client with invalid credentials. Double-check your API key and fix your client with `@client.api_key = <VALID_API_KEY>`.
+* **Rescuetime::InvalidQueryError** is raised if you enter an invalid value for any of the RescueTime query methods (or if the server returns a bad query error)
+* **Rescuetime::InvalidFormatError** is raised if you pass a disallowed format to the client
+* HTTP Response Errors:
+  * **4xx => Rescuetime:: ClientError**
+  * 400 => Rescuetime::BadRequest
+  * 401 => Rescuetime::Unauthorized
+  * 403 => Rescuetime::Forbidden
+  * 404 => Rescuetime::NotFound
+  * 406 => Rescuetime::NotAcceptable
+  * 422 => Rescuetime::UnprocessableEntity
+  * 429 => Rescuetime::TooManyRequests
+  * **5xx => Rescuetime:: ServerError**
+  * 500 => Rescuetime::InternalServerError
+  * 501 => Rescuetime::NotImplemented
+  * 502 => Rescuetime::BadGateway
+  * 503 => Rescuetime::ServiceUnavailable
+  * 504 => Rescuetime::GatewayTimeout
 
 ## Development
 

data/Rakefile

@@ -8,4 +8,4 @@ RSpec::Core::RakeTask.new(:spec)
 task test: :spec
 
 desc 'Default: run specs'
-task default: :spec
+task default: :spec

data/lib/rescuetime.rb

@@ -2,6 +2,7 @@ require 'rescuetime/version'
 require 'rescuetime/client'
 require 'rescuetime/errors'
 
+# lib/rescuetime.rb
 module Rescuetime
   # Wrapper module for rescuetime gem
   #

data/lib/rescuetime/client.rb

@@ -1,7 +1,10 @@
 require 'faraday'
 require 'csv'
 
-require 'rescuetime/api'
+require 'rescuetime/query_buildable'
+
+require 'rescuetime/requester'
+require 'rescuetime/collection'
 
 module Rescuetime
   # Rescuetime::Client makes HTTP requests to the RescueTime API and returns
@@ -9,117 +12,33 @@ module Rescuetime
   #
   # @since v0.1.0
   class Client
-    include Rescuetime::Api
-
-    # Default options passed in any request
-    # @since v0.2.0
-    DEFAULT_OPTIONS = {format: 'csv', version: 0, operation: 'select' }
+    include QueryBuildable
 
-    # Overwrites the set RescueTime API key
-    #
-    # @!attribute [w] api_key
+    # @!attribute [rw] api_key
     # @since v0.1.0
-    attr_writer :api_key
+    attr_accessor :api_key
 
-    # Initializes a new Client object
-    #
-    # @example
-    #   @client = Rescuetime::Client.new  # options must be set before requests can be made
-    # @example
-    #   @client = Rescuetime::Client.new(api_key: '1234567890abcdefg')
-    #
-    # @param [Hash] options hash of RescueTime client options
-    # @option options [String] :api_key RescueTime API key
-    # @return [Rescuetime::Client]
     # @since v0.1.0
-    def initialize(options={})
-      @api_key = options[:api_key]
+    def initialize(key = nil, **opts)
+      @api_key    = key || opts[:api_key]
     end
 
-    # Checks whether an api key is set
-    #
-    # @return [Boolean]
     # @since v0.1.0
     def api_key?
-      !!@api_key
+      !!@api_key && !@api_key.empty?
     end
 
-    # Checks whether client credentials are valid. If credentials are present, this
-    # action involves an HTTP request.
-    #
-    # @example Three cases of checking credentials (missing, invalid, and valid)
-    #   @client = Rescuetime::Client.new
-    #   @client.valid_credentials?        # => false
-    #
-    #   # Note: The following scenarios involve an HTTP request.
-    #   @client.api_key = 'Invalid Key'
-    #   @client.valid_credentials?        # => false
-    #
-    #   @client.api_key = VALID_API_KEY
-    #   @client.valid_credentials?        # => true
-    #
-    # @return [Boolean]
     # @since v0.2.0
     def valid_credentials?
       return false unless api_key?
-      !!self.activities rescue false
+      !!activities.all rescue false
     end
 
-    protected
-
-    # Performs an HTTP get request
-    #
-    # @param [String] url request url
-    # @param [Hash] options query params for request
-    #
-    # @raise [Rescuetime::MissingCredentials] if the Rescuetime::Client has no set api key
-    # @raise [Rescuetime::InvalidCredentials] if the provided api key is rejected by RescueTime
-    # @since v0.2.0
-    def get(url, options={})
-      raise Rescuetime::MissingCredentials unless api_key?
-      response = Faraday.get url, query_params(options).
-                                    merge(DEFAULT_OPTIONS).
-                                    merge({key: @api_key})
-
-      invalid_credentials_body = '{"error":"# key not found","messages":"key not found"}'
-      raise Rescuetime::InvalidCredentials if response.body == invalid_credentials_body
-
-      response
-    end
-
-    # Takes client request options hash and returns correct key/value pairs for HTTP request
-    #
-    # @param [Hash] options options hash of client request
-    # @return [Hash]
-    # @since v0.2.0
-    def query_params(options)
-      params = {}
-      params_mapping = { detail: :restrict_kind, by: :perspective, interval: :resolution_time }
-
-      params_mapping.each do |local, server|
-        params[server] = options[local] if options[local]
-      end
-
-      # Special Cases
-      params[:perspective] = 'interval' if params[:perspective] == 'time'
-      if options[:date]
-        params[:restrict_begin] = date_string options[:date]
-        params[:restrict_end] = params[:restrict_begin]
-      end
-      if options[:from]
-        params[:restrict_begin] = date_string options[:from]
-        params[:restrict_end] = date_string(options[:to] || Time.now)
-      end
-      params
-    end
+    private
 
-    # Takes a date in either "YYYY-MM-DD" format or as a Time object and
-    # returns a date string in "YYYY-MM-DD" format
-    #
-    # @return [String]
-    def date_string(date)
-      return date if date.is_a? String
-      date.strftime('%Y-%m-%d')
+    # @since v0.3.0
+    def state
+      { key: @api_key }
     end
   end
-end
+end

data/lib/rescuetime/collection.rb

@@ -0,0 +1,51 @@
+require 'rescuetime/query_buildable'
+
+module Rescuetime
+  class Collection
+    include QueryBuildable
+    include Enumerable
+
+    HOST = 'https://www.rescuetime.com/anapi/data'
+
+    def initialize(*terms)
+      @params = terms.reduce({}, :merge)
+      @format = :array
+    end
+
+    def <<(terms)
+      @params.merge! terms
+    end
+
+    def all
+      parse_response Requester.get(HOST, @params).body
+    end
+
+    def each(&block)
+      all.each &block
+    end
+
+    # TODO: Chainable to client
+    def format(format)
+      fail InvalidFormatError unless %w(array csv).include? format.to_s
+      @format = format.to_sym
+      self
+    end
+
+    private
+
+    # @since v0.1.0
+    def parse_response(body)
+      report = CSV.new(body,
+                         headers: true,
+                         header_converters: :symbol,
+                         converters: :all)
+
+      case @format
+      when :array then report.to_a.map(&:to_hash)
+      when :csv   then report
+      else
+        fail InvalidFormatError
+      end
+    end
+  end
+end

data/lib/rescuetime/errors.rb

@@ -2,9 +2,85 @@ module Rescuetime
   # Error class for rescuing all RescueTime errors
   class Error < StandardError; end
 
+  ##
+  # HTTP Errors
+  # ===========
+  # 4xx HTTP status code
+  class ClientError < Error; end
+  # HTTP status code 400
+  class BadRequest < ClientError; end
+  # HTTP status code 401
+  class Unauthorized < ClientError; end
+  # HTTP status code 403
+  class Forbidden < ClientError; end
+  # HTTP status code 404
+  class NotFound < ClientError; end
+  # HTTP status code 406
+  class NotAcceptable < ClientError; end
+  # HTTP status code 422
+  class UnprocessableEntity < ClientError; end
+  # HTTP status code 429
+  class TooManyRequests < ClientError; end
+
+  # 5xx HTTP status code
+  class ServerError < Error; end
+  # HTTP status code 500
+  class InternalServerError < ServerError; end
+  # HTTP status code 501
+  class NotImplemented < ServerError; end
+  # HTTP status code 502
+  class BadGateway < ServerError; end
+  # HTTP status code 503
+  class ServiceUnavailable < ServerError; end
+  # HTTP status code 504
+  class GatewayTimeout < ServerError; end
+
+  ##
+  # Custom Errors
+  # =============
+  # class CredentialsError < Error; end
   # Raised when a method requires credentials but none are provided
-  class MissingCredentials < Error; end
+  class MissingCredentialsError < Unauthorized
+    def initialize(msg = 'No API key provided. Please provide a valid key.')
+      super
+    end
+  end
+
+  # Raised when a method requires credentials but credentials are invalid
+  class InvalidCredentialsError < Unauthorized
+    def initialize(msg = 'API key is invalid. Please provide a valid key.')
+      super
+    end
+  end
+
+  # Raised when a user-submitted query value is invalid
+  class InvalidQueryError < BadRequest
+    def initialize(msg = 'Likely a badly formatted or missing parameter')
+      super
+    end
+  end
+
+  # Raised when a user-submitted query value is invalid
+  class InvalidFormatError < Error
+    def initialize(msg = 'Invalid format. Please see docs for allowed formats.')
+      super
+    end
+  end
 
-  # Raised when a method requires credentials but provided credentials are invalid
-  class InvalidCredentials < Error; end
-end
+  class Error
+    CODES = {
+      400 => Rescuetime::BadRequest,
+      401 => Rescuetime::Unauthorized,
+      403 => Rescuetime::Forbidden,
+      404 => Rescuetime::NotFound,
+      406 => Rescuetime::NotAcceptable,
+      422 => Rescuetime::UnprocessableEntity,
+      429 => Rescuetime::TooManyRequests,
+      500 => Rescuetime::InternalServerError,
+      501 => Rescuetime::NotImplemented,
+      502 => Rescuetime::BadGateway,
+      503 => Rescuetime::ServiceUnavailable,
+      504 => Rescuetime::GatewayTimeout
+    }
+  end
+end

data/lib/rescuetime/query_buildable.rb

@@ -0,0 +1,114 @@
+module Rescuetime
+  # The Rescuetime::Reportable module contains client methods relating to
+  # generating requests to fetch reports on the /data endpoint of the
+  # Data Analytics API.
+  #
+  # @since v0.1.0
+  module QueryBuildable
+    BASE_PARAMS = { format:     'csv',
+                    operation:  'select',
+                    version:    0 }
+
+    # @return [Rescuetime::Collection]
+    # @since v0.3.0
+    def overview
+      add_to_query restrict_kind: 'overview'
+    end
+
+    # @return [Rescuetime::Collection]
+    # @since v0.3.0
+    def categories
+      add_to_query restrict_kind: 'category'
+    end
+
+    # @return [Rescuetime::Collection]
+    # @since v0.1.0
+    def activities
+      add_to_query restrict_kind: 'activity'
+    end
+
+    # @return [Rescuetime::Collection]
+    # @since v0.2.0
+    def productivity
+      add_to_query restrict_kind: 'productivity'
+    end
+
+    # @return [Rescuetime::Collection]
+    # @since v0.2.0
+    def efficiency
+      add_to_query restrict_kind: 'efficiency', perspective: 'interval'
+    end
+
+    # @return [Rescuetime::Collection]
+    # @since v0.3.0
+    def order_by(order, opts = {})
+      fail(InvalidQueryError, "#{order} is not a valid order") unless
+          VALID[:order_by].include? order
+      fail(InvalidQueryError, "#{opts[:interval]} is not a valid interval") if
+          opts[:interval] && !VALID[:interval].include?(opts[:interval])
+
+      add_to_query perspective: (order.to_s == 'time' ? 'interval' : order),
+                   resolution_time: opts[:interval] || opts['interval']
+    end
+
+    # @return [Rescuetime::Collection]
+    # @since v0.3.0
+    def date(date)
+      add_to_query restrict_end:    to_formatted_s(date),
+                   restrict_begin:  to_formatted_s(date)
+    end
+
+    # @return [Rescuetime::Collection]
+    # @since v0.3.0
+    def from(date)
+      add_to_query restrict_begin:  to_formatted_s(date)
+    end
+
+    # @return [Rescuetime::Collection]
+    # @since v0.3.0
+    def to(date)
+      add_to_query restrict_end:    to_formatted_s(date)
+    end
+
+    # @return [Rescuetime::Collection]
+    # @since v0.3.0
+    def where(options)
+      add_to_query restrict_thing:  options[:name],
+                   restrict_thingy: options[:document]
+    end
+
+    private
+
+    VALID = {
+      order_by: [:time, :rank, :member],
+      interval: [:minute, :hour, :day, :week, :month]
+    }
+
+    def add_to_query(**terms)
+      if self.is_a? Rescuetime::Collection
+        self << terms
+        self
+      else
+        Rescuetime::Collection.new(BASE_PARAMS, state, terms)
+      end
+    end
+
+    # @since v0.3.0
+    def to_formatted_s(date)
+      case
+      when date.respond_to?(:strftime)      then date.strftime('%Y-%m-%d')
+      when date =~ /\d{4}-\d{2}-\d{2}/      then date
+      when date =~ %r{\d{4}\/\d{2}\/\d{2}}  then date.gsub '/', '-'
+      when date =~ %r{\d{2}[-\/]\d{2}[-\/]\d{4}/}
+        date_chunks = date.scan(/\d+/)
+        "#{ date_chunks[2] }-#{ date_chunks[0] }-#{ date_chunks[1] }"
+      when date =~ %r{\d{2}[-\/]\d{2}}
+        date_chunks = date.scan(/\d+/)
+        "#{ Time.now.year }-#{ date_chunks[0] }-#{ date_chunks[1] }"
+      else
+        fail InvalidQueryError,
+             'Invalid date entered. Please see docs for allowed formats.'
+      end
+    end
+  end
+end

data/lib/rescuetime/requester.rb

@@ -0,0 +1,40 @@
+module Rescuetime
+  # The Rescuetime::Requestable module contains client methods relating to
+  # sending HTTP requests
+  #
+  # @since v0.2.0
+  class Requester
+    class << self
+      # @since v0.2.0
+      def get(host, params)
+        fail(Rescuetime::MissingCredentialsError) unless
+          params[:key] && !params[:key].to_s.empty?
+
+        response = Faraday.get(host,
+                               params.delete_if { |_, v| !v || v.to_s.empty? })
+
+        fail_or_return response
+      end
+
+      private
+
+      INVALID = {
+        key_not_found: '"error":"# key not found","messages":"key not found"',
+        query: '"error": "# query error",'\
+            '"messages": "Error: Likely a badly formatted or missing parameter"'
+      }
+
+      def fail_or_return(response)
+        fail Rescuetime::InvalidCredentialsError if
+          response.body =~ /#{INVALID[:key_not_found]}/
+        fail Rescuetime::InvalidQueryError if
+          response.body =~ /#{INVALID[:query]}/
+
+        error = Rescuetime::Error::CODES[response.status.to_i]
+        fail(error) if error
+
+        response
+      end
+    end
+  end
+end

data/lib/rescuetime/version.rb

@@ -1,5 +1,5 @@
 # Contains Rescuetime::VERSION, the gem version number
 module Rescuetime
   # rescuetime gem version number
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/rescuetime.gemspec

@@ -9,17 +9,18 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Lee Sharma']
   spec.email         = ['lee@leesharma.com']
 
-  spec.summary       = %q{Ruby interface for RescueTime}
-  spec.description   = %q{Ruby interface for the RescueTime Data Analytics API.}
+  spec.summary       = %w(Ruby interface for RescueTime)
+  spec.description   = %w(Ruby interface for the RescueTime Data Analytics API.)
   spec.homepage      = 'https://github.com/leesharma/rescuetime'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0")
+                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency 'faraday', '~> 0.9.1'
 
@@ -27,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
 
   spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+  spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'vcr', '~> 2.9', '>= 2.9.3'
   spec.add_development_dependency 'webmock', '~> 1.21', '>= 1.21.0'
 end

metadata

@@ -1,133 +1,148 @@
 --- !ruby/object:Gem::Specification
 name: rescuetime
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Lee Sharma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: bundler
   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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.9.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.9.3
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.21.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.21.0
-description: Ruby interface for the RescueTime Data Analytics API.
+description: '["Ruby", "interface", "for", "the", "RescueTime", "Data", "Analytics",
+  "API."]'
 email:
 - lee@leesharma.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -138,10 +153,11 @@ files:
 - bin/console
 - bin/setup
 - lib/rescuetime.rb
-- lib/rescuetime/activities.rb
-- lib/rescuetime/api.rb
 - lib/rescuetime/client.rb
+- lib/rescuetime/collection.rb
 - lib/rescuetime/errors.rb
+- lib/rescuetime/query_buildable.rb
+- lib/rescuetime/requester.rb
 - lib/rescuetime/version.rb
 - rescuetime.gemspec
 homepage: https://github.com/leesharma/rescuetime
@@ -154,12 +170,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -167,5 +183,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Ruby interface for RescueTime
+summary: '["Ruby", "interface", "for", "RescueTime"]'
 test_files: []
+has_rdoc: 

data/lib/rescuetime/activities.rb

@@ -1,182 +0,0 @@
-module Rescuetime
-  # The Rescuetime::Activities module contains client methods relating to user
-  # activities on the /data endpoint of the Data Analytics API.
-  #
-  # @since v0.1.0
-  module Activities
-    # Base URL for RescueTime Data Analytics API endpoint
-    # @since v0.1.0
-    BASE_URL = 'https://www.rescuetime.com/anapi/data'
-    # Map of numeric productivity levels to meaning
-    # @since v0.2.0
-    PRODUCTIVITY_LEVELS = { -2  => 'Very Unproductive',
-                            -1  => 'Unproductive',
-                            0   => 'Neutral',
-                            1   => 'Productive',
-                            2   => 'Very Productive' }
-
-    # Returns array of all activities.
-    #
-    # @example Basic behavior
-    #   @activities = @client.activities
-    #   @activities.class     # => Array
-    #   @acitvities[0].class  # => Hash
-    #
-    #   @activities[0]
-    #   # =>  {
-    #   #       :rank=>1,
-    #   #       :time_spent_seconds=>5307,
-    #   #       :number_of_people=>1,
-    #   #       :activity=>"github.com",
-    #   #       :category=>"General Software Development",
-    #   #       :productivity=>2
-    #   #     }
-    #
-    # @example Set level of detail
-    #   @client.activities(detail: 'overview')[0]
-    #   # => { :rank=>1, :time_spent_seconds=>13140, :number_of_people=>1, :category=>'Software Development' }
-    #
-    #   @client.activities(detail: 'category')[0]
-    #   # => { :rank=>1, :time_spent_seconds=>5835, :number_of_people=>1, :category=>'Editing and IDEs' }
-    #
-    #   @client.activities(detail: 'activity')[0]
-    #   # => { :rank=>1,
-    #   #      :time_spent_seconds=>5835,
-    #   #      :number_of_people=>1,
-    #   #      :category=>'Editing and IDEs',
-    #   #      :activity=>'RubyMine',
-    #   #      :productivity=>2 }
-    #
-    #   @client.activities(detail: 'productivity')              # Equivalent to @client.productivity
-    #   @client.activities(detail: 'efficiency', by: 'time')    # Equivalent to @client.efficiency
-    #
-    # @example Set perspective
-    #   @client.activities(by: 'rank')     # Returns activities by rank (time spent per activity)
-    #   @client.activities(by: 'interval') # Returns activities chronologically
-    #   @client.activities(by: 'member')   # Returns activities grouped by member
-    #
-    # @example Set date range (note: no time constraints are allowed)
-    #   @client.activities(date: '2014-05-06')                      # Returns report for May 6, 2014
-    #   @client.activities(from: '2014-05-06', to: '2014-06-06')    # Returns report for May 6 to June 6, 2014
-    #   @client.activities(from: '2015-04-10')                      # Returns report for April 10, 2015 to today
-    #
-    # @example Set time interval
-    #   @client.efficiency( from: '2015-01-01',    # Returns an efficiency report by
-    #                       to: Time.now,          # week from the Jan 1, 2015 through
-    #                       interval: 'week')      # today.
-    #
-    # @example Format
-    #   @client.activities                # Returns array of hashes
-    #   @client.activities format: 'csv'  # Returns Mime::CSV
-    #
-    # @param [Hash] options Query parameters to be passed to RescueTime
-    # @option options [String] :detail
-    #   Restricts the level of detail of report returned
-    #   1. 'overview': sums statistics for all activities into their top level category
-    #   2. 'category': sums statistics for all activities into their sub category
-    #   3. 'activity' (default): sums statistics for individual applications / web sites / activities
-    #   4. 'productivity': productivity calculation (@see #productivity)
-    #   5. 'efficiency': efficiency calculation (not applicable in "rank" perspective, @see #efficiency)
-    # @option options [String] :by
-    #   Lets you set the perspective of your report
-    #   1. 'rank' (default): returns a ranked report of activities by total time spent
-    #   2. 'time': returns a chronological report of activities
-    #   3. 'member': returns an activity report grouped by member
-    # @option options [String] :date
-    #   Lets you set a single date for your report in a 'YYYY-MM-DD' format. Not
-    #   valid with :to or :from. Cannot be a future date.
-    # @option options [String] :from
-    #   Lets you set a start date for your report in a 'YYYY-MM-DD' format. Valid
-    #   with the :to option or alone (:to defaults to current date). Cannot be a
-    #   future date or after the :to date (if supplied).
-    # @option options [String] :to
-    #   Lets you set an end date for your report in a 'YYYY-MM-DD' format. If a
-    #   :to is supplied, :from must be supplied as well. Cannot be a future date or
-    #   before the :from date.
-    # @option options [String] :interval
-    #   Lets you set the time interval for your report (ie. client.efficiency(interval:'day')
-    #   returns the efficiency report by day.) Possible values include:
-    #   1. 'minute': returns data in 5-minute increments
-    #   2. 'hour' (default): returns data in 1-hour increments
-    #   3. 'day': returns data in 1-day increments
-    #   4. 'week': returns data in 1-week increments
-    #   5. 'month': returns data in 1-month increments
-    # @option options [String] :format
-    #   Lets you specify a return type for your report
-    #   1. default: returns an array of hashes with symbolized keys
-    #   2. 'csv': returns a Mime::CSV object
-    #
-    # @return [Array<Hash>]
-    #
-    # @raise [Rescuetime::MissingCredentials] if the Rescuetime::Client has no set api key
-    # @raise [Rescuetime::InvalidCredentials] if the provided api key is rejected by RescueTime
-    # @since v0.1.0
-    def activities(options={})
-      response = self.get BASE_URL, options
-
-      case options[:format]
-        when 'csv' then CSV.new(response.body, headers: true)
-        else array_of_hashes_from_csv(response.body)
-      end
-    end
-
-    # Returns efficiency report. Equivalent to #activities(by: time, detail: efficiency)
-    # @see #activities valid options
-    #
-    # @param [Hash] options options hash (same as #activities)
-    # @return [Array<Hash>]
-    def efficiency(options={})
-      self.activities({by: 'time'}.merge(options.merge(detail: 'efficiency')))
-    end
-
-    # Returns productivity report. Equivalent to #activities(detail: productivity)
-    # @see #activities valid options
-    #
-    # @example
-    #   @client.productivity    # Equivalent to @client.activities(detail: 'productivity')
-    #   # =>  [
-    #   #       { :rank=>1, :time_spent_seconds=>6956, :number_of_people=>1, :productivity=>2 },
-    #   #       { :rank=>2, :time_spent_seconds=>2635, :number_of_people=>1, :productivity=>-2 },
-    #   #       { :rank=>3, :time_spent_seconds=>2415, :number_of_people=>1, :productivity=>1 },
-    #   #       { :rank=>4, :time_spent_seconds=>1210, :number_of_people=>1, :productivity=>0 },
-    #   #       { :rank=>5, :time_spent_seconds=>93, :number_of_people=>1, :productivity=>-1 }
-    #   #     ]
-    #
-    # @param [Hash] options options hash (same as #activities)
-    # @return [Array<Hash>]
-    def productivity(options={})
-      self.activities(options.merge(detail: 'productivity'))
-    end
-
-    # Returns map of numeric productivity levels to meaning
-    #
-    # @example
-    #   @activity = @client.activities(restrict_kind: 'productivity')[0]
-    #   @primary_productivity = @client.productivity_levels[@activity[:productivity]]
-    #
-    #   puts "I have spent most of my time being #{@primary_productivity}."
-    #   # => I have spent most of my time being Very Productive.
-    #
-    # @return [Hash] productivity levels, with integers from -2 to 2 as keys
-    # @since v0.2.0
-    def productivity_levels
-      PRODUCTIVITY_LEVELS
-    end
-
-    private
-
-    # Takes a CSV with headers and returns an array of hashes
-    #
-    # @param body[CSV] the original CSV file
-    # @return [Array] an array of hashes, containing keys of the CSV headers
-    # @since v0.1.0
-    def array_of_hashes_from_csv(body)
-      activities = CSV.new(body,
-                           headers: true,
-                           header_converters: :symbol,
-                           converters: :all)
-
-      activities.to_a.map(&:to_hash)
-    end
-  end
-end

data/lib/rescuetime/api.rb

@@ -1,13 +0,0 @@
-require 'rescuetime/activities'
-
-module Rescuetime
-  # The Rescuetime::API module includes all modules corresponding to RescueTime
-  # API endpoints.
-  #
-  # For more information on the RescueTime Client, see #Rescuetime::Client.
-  # For more information on included methods, see method summary below.
-  # @since v0.1.0
-  module Api
-    include Rescuetime::Activities
-  end
-end