rescuetime 0.3.2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6464e2b8b391cfa2b334288ba6cdbd81fe7728f6
-  data.tar.gz: e293998bd6552509d6225422b1a7f029a26dcde3
+  metadata.gz: 2a432c96ac3df86019ae962948bdddacfcb74d6d
+  data.tar.gz: 34d4785182403bc262e017592e4f911700e39768
 SHA512:
-  metadata.gz: 4e022e5eefb8a858051f8c5264d394562ba6939381beb5b9072807f2dad2a70f9d8047ada933a2be9172ba050ed5b71ed41e51934e1b2a8ade83bd67d7a645c2
-  data.tar.gz: 8c09915abb016f0680d9b48c1f45362ccf6312fc970f1e58d38feeb25e15afda6cfeba1d5f18a877712ac7b29bce2e65f39cdf14ebea57caf79f26fbcdc5df33
+  metadata.gz: 7b584353be255e265d40f93e80c04cb6a8542b20f12c37520ac2dead84d1caad627493755f3bd1e267da155e6e5c38fe212a5975acc38fef58bc0af15a582ca0
+  data.tar.gz: 7758b44a45ee0fef13e367a85bbf84ea18576ff226234adc4e68abaaa7b3d2b0c3b00d421ab0024fae0d8755ef38e004ac56e5017372b94a5bc545470af8e3ae

data/.gitignore

@@ -8,4 +8,7 @@
 /spec/reports/
 /tmp/
 
-secret.rb
+secret.rb
+
+# asdf ruby version management
+.tool-versions

data/.rubocop.yml

@@ -1 +1,4 @@
-inherit_from: .rubocop_todo.yml
+inherit_from: .rubocop_todo.yml
+
+Style/SignalException:
+  EnforcedStyle: only_raise

data/.rubocop_todo.yml

@@ -1,80 +1,58 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-05-22 00:42:00 -0400 using RuboCop version 0.40.0.
+# on 2016-05-26 15:32:03 -0400 using RuboCop version 0.40.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-Lint/AmbiguousOperator:
-  Exclude:
-    - 'lib/rescuetime/collection.rb'
+# Offense count: 23
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 91
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 13
 
-# Offense count: 1
+# Offense count: 8
 # Cop supports --auto-correct.
-Performance/StringReplacement:
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# IgnoredMethods: lambda, proc, it
+Style/BlockDelimiters:
   Exclude:
-    - 'lib/rescuetime/date_parser.rb'
+    - 'spec/rescuetime/core_extensions/object/blank_spec.rb'
+    - 'spec/rescuetime/date_parser_spec.rb'
+    - 'spec/rescuetime/formatters/array_formatter_spec.rb'
+    - 'spec/rescuetime/formatters/csv_formatter_spec.rb'
+    - 'spec/rescuetime/report_formatters_spec.rb'
+    - 'spec/rescuetime/requester_spec.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
+# Offense count: 7
 # Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: always, conditionals
-Style/AndOr:
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
   Exclude:
-    - 'lib/rescuetime/query_buildable.rb'
+    - 'lib/rescuetime/core_extensions/object.rb'
+    - 'lib/rescuetime/core_extensions/object/blank.rb'
+    - 'lib/rescuetime/core_extensions/string.rb'
+    - 'lib/rescuetime/formatters/array_formatter.rb'
+    - 'lib/rescuetime/formatters/base_formatter.rb'
+    - 'lib/rescuetime/formatters/csv_formatter.rb'
+    - 'spec/fixtures/formatters/fake_formatter.rb'
 
-# Offense count: 5
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
-# SupportedStyles: aligned, indented
-Style/MultilineMethodCallIndentation:
-  Enabled: false
-
-# Offense count: 9
-# Cop supports --auto-correct.
-Style/MutableConstant:
-  Exclude:
-    - 'lib/rescuetime/collection.rb'
-    - 'lib/rescuetime/date_parser.rb'
-    - 'lib/rescuetime/errors.rb'
-    - 'lib/rescuetime/query_buildable.rb'
-    - 'lib/rescuetime/requester.rb'
-    - 'lib/rescuetime/version.rb'
-    - 'spec/sample_secret.rb'
-    - 'spec/secret.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/NestedParenthesizedCalls:
+# Offense count: 1
+Style/DoubleNegation:
   Exclude:
-    - 'spec/rescuetime/query_buildable_spec.rb'
+    - 'lib/rescuetime/core_extensions/object/blank.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/ParallelAssignment:
   Exclude:
     - 'spec/rescuetime/query_buildable_spec.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RedundantSelf:
-  Exclude:
-    - 'lib/rescuetime/query_buildable.rb'
-
-# Offense count: 10
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: only_raise, only_fail, semantic
-Style/SignalException:
-  Exclude:
-    - 'lib/rescuetime/collection.rb'
-    - 'lib/rescuetime/date_parser.rb'
-    - 'lib/rescuetime/query_buildable.rb'
-    - 'lib/rescuetime/requester.rb'

data/.travis.yml

@@ -5,7 +5,9 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
-  - ruby-head
+  - 2.3
+  - 2.4
+  - 2.5
 
 addons:
   code_climate:

data/CHANGELOG.md

@@ -0,0 +1,320 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+See also
+- [GitHub releases](https://github.com/leesharma/rescuetime/releases)
+
+## [Unreleased] - current
+
+...
+
+---
+
+## [v1.0.1] - 2019-02-16
+
+Mention max ruby version in gemspec
+
+### Updates
+
+No code updates. It looks like some functionality breaks under ruby 2.4+, so
+this change updates the gemspec to reflect this. A future update will probably
+resolve the bug.
+
+## [v1.0.0] - 2016-08-26
+
+Bump Version and Misc Updates
+
+### Updates
+
+The only update (aside from the version bump) is specifying that executables
+are kept in the `bin` directory, not the `exe` directory. This version bump
+is mainly to signify that the API is stable.
+
+## [v0.4.0] - 2016-04-26
+
+Add Custom Formatters and Misc Updates
+
+### Breaking Changes
+
+Exception classes, which were previously in the top-level Rescuetime (ex. Rescuetime::InvalidQueryError) are now under the Rescuetime::Errors module. This change was made for better code organization.
+
+### Updates
+
+#### Allow Frozen String Literals
+
+If you're using ruby 2.3, rescuetime will now work with the `# frozen_string_literals: true` option set.
+
+#### Custom Formatters
+
+The big change in this update is that users can now add/configure custom formatters.
+
+Rescuetime ships with two report formats: CSV and Array. If you would like your
+report in a different format, don't worry–it's easy to add a custom formatter.
+
+Three things are required to add a custom formatter:
+
+    - Write a class within the module `Rescuetime::Formatters` that inherits from `Rescuetime::Formatters::BaseFormatter` or one of its descendants
+    - Define the class methods `.name` and `.format`
+    - Register your formatters using `Rescuetime.configure`
+
+##### Writing a Formatter
+
+First, the formatters themselves. Here is a basic formatter:
+
+```ruby
+# config/formatters/nil_formatter.rb
+module Rescuetime::Formatters
+  # Turns a productivity report into nothing useful.
+  class NilFormatter < BaseFormatter
+    # @return [String]  name of this report format
+    def self.name
+      'nil'
+    end
+
+    # @param  [CSV] _report  the raw CSV report from Rescuetime
+    # @return [nil]          the formatted output (in this case, nil)
+    def self.format(_report)
+      nil
+    end
+  end
+end
+```
+
+You can even inherit from an existing formatter:
+
+```ruby
+# config/formatters/shouty_array_formatter.rb
+module Rescuetime::Formatters
+  # Formats a rescuetime report as an array of hashes, except shouting.
+  class ShoutyArrayFormatter < ArrayFormatter
+    # @return [String]  name of this report format
+    def self.name
+      'shouty_array'
+    end
+
+    # @param  [CSV]         report  the raw CSV report from Rescuetime
+    # @return [Array<Hash>]         the formatted output (in this case, a shouty
+    #                               array of hashes)
+    def self.format(report)
+      array = super(report)
+      array.map do |hash|
+        terms = hash.map { |key, value| [key.to_s.upcase, value.to_s.upcase] }
+        Hash[terms]
+      end
+    end
+  end
+end
+```
+
+##### Registering your Formatters
+
+Before setting your report format, add the path to your formatter(s) to the
+Rescuetime configuration using the Rescuetime.configure method. You will be
+able to set, append to, or manipulate the formatter_paths setting.
+
+```ruby
+Rescuetime.configure do |config|
+  path = File.expand_path('../my_custom_formatter.rb', __FILE__)
+  config.formatter_paths = [path]
+end
+```
+
+Now Rescuetime will look for the my_custom_formatter.rb file. Multiple paths
+may be added as well.
+
+```ruby
+Rescuetime.configure do |config|
+  config.formatter_paths = [
+    'config/formatters/*_formatter.rb',
+    'lib/formatters/**/*_formatter.rb',
+  ]
+end
+```
+
+### Documentation
+
+Increased documentation coverage/quality
+
+### Test Coverage
+
+Increased
+
+## [v0.3.3] - 2016-05-21
+
+Remove the dependency to Faraday
+
+### Refactoring
+
+Switch from using Faraday to Net::HTTP in order to reduce production dependencies.
+
+---
+
+## [v0.3.2] - 2016-05-21
+
+Documentation Comments and Refactoring
+
+### Documentation
+
+Public methods and classes now have 100% documentation coverage, and the documentation was expanded to include descriptions, examples, links, and more.
+
+###Refactoring
+
+The `Rescuetime::DateParser` class was extracted from the `Rescuetime::QueryBuilder`, keyword arguments were added in preference to the options hash, and other code readability/maintainability changes were made.
+
+This release shouldn't affect the behavior or interface of the gem, and it adds no new features.
+
+---
+
+## [v0.3.1] - 2015-05-04
+
+Fix gemspec description
+
+### Minor fix:
+
+gemspec description used `%w(...)`, changed to string
+
+---
+
+## [v0.3.0] - 2015-05-04
+
+### Focus
+
+Method Chaining and Lazy Evaluation
+
+### Updates
+
+This release introduces many breaking changes to the codebase. Since the gem is still in development (v0.x.x), the major version has not increased.
+
+The major goal of this release was refactoring and adding method chaining and lazy evaluation. Additionally, results can now be limited by overview/category/activity name as well as document name,.
+
+Queries can now be formed with the following syntax:
+
+```ruby
+client = Rescuetime::Client.new RESCUETIME_API_KEY
+#=> <#Rescuetime::Client:...>
+
+# Build the query
+activities = client.activities.from(1.week.ago).where(name: 'github.com').format('csv')
+#=> <#Rescuetime::Collection:...>
+
+# Perform the query with #all or an enumerable method (#each, #map, #any?, etc.)
+activities.all
+#=> <#CSV:...>
+```
+
+---
+
+## [v0.2.0] - 2015-04-23
+
+### Scope
+
+Provides nearly-full coverage of the RescueTime Analytic Data API.
+
+### Features
+
+```ruby
+# Basics
+@client = Rescuetime::Client.new
+
+@client.api_key?            #=> false
+@client.valid_credentials?  #=> false
+@client.activities          #=> Rescuetime::MissingCredentials
+
+@client.api_key='invalid'
+@client.api_key?            #=> true
+@client.valid_credentials?  #=> false
+@client.activities          #=> Rescuetime::InvalidCredentials
+
+@client.api_key= VALID_KEY
+@client.valid_credentials?  #=> true
+
+
+
+
+# #productivity_levels
+@client.productivity_levels     #=> Hash
+@client.productivity_levels[-2] #=> 'Very Unproductive'
+@client.productivity_levels[0]  #=> 'Neutral'
+
+
+
+
+# #activities
+@client.activities          #=> Array<Hash>
+@client.activities.first    #=> Hash
+
+#   :by (report order/perspective)
+@client.activities(by: 'rank')    # returns ranked report by time spent per activity/category
+@client.activities(by: 'time')    # returns chronological report
+@client.activities(by: 'member')  # returns report grouped by member
+
+#   :detail (detail level of report)
+@client.activities(detail: 'overview')    # returns report at the 'overview' level (ie. Entertainment)
+@client.activities(detail: 'category')    # returns report at the 'category' level (ie. News and Opionion)
+@client.activities(detail: 'activity')    # returns report at the 'activity' level (ie. reddit.com)
+                                          # note: 'productivity' and 'efficiency' are options as well, but
+                                          #       #productivity and #efficiency are the preferred way to 
+                                          #       get that information.
+
+#   :date, :from, and :to (date range of report)
+@client.activities(date: '2015-04-02')    # returns report for selected date
+@client.activities(from: '2015-04-18')    # returns report between selected and current date
+@client.activities(from: Time.new(2015,04,19))            # time objects work too
+@client.activities(from: '2015-04-02', to: '2015-04-02')  # returns report between start and end date
+
+#   :interval (time interval of the report)
+@client.activities(by: 'time', interval: 'minute')        # returns report in 5-minute intervals
+@client.activities(by: 'time', interval: 'hour')          # returns report in 1-hour intervals
+@client.activities(by: 'time', interval: 'day')           # returns report in 1-day intervals
+@client.activities(by: 'time', interval: 'week')          # returns report in 1-week intervals
+@client.activities(by: 'time', interval: 'month')         # returns report in 1-month intervals
+
+#   :format (output format)
+@client.activities                  #=> Array<Hash>
+@client.activities(format: 'csv')   #=> CSV
+
+
+
+
+# #productivity
+@client.productivity(...)                 # productivity takes the same options as #activities except :detail
+                                          # returns a productivity report with the given options
+
+
+
+# #efficiency
+@client.efficiency(...)                   # efficiency takes the same options as #activities except :detail
+                                          # returns an efficiency report with the given options
+
+
+
+# All of this can be used together
+@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' )
+```
+
+---
+
+## [v0.1.0] - 2015-04-15
+
+Initial gem release
+
+### Features
+- Rescuetime has a version number
+- `Rescuetime::Client` exists
+- `Rescuetime::Client#api_key?` returns existence of api key
+- `Rescuetime::Client#api_key=` overwrites api key
+- `Rescuetime::Client#activities` returns list of activities
+
+[Unreleased]: https://github.com/leesharma/rescuetime/compare/v0.4.0...HEAD
+[v0.4.0]: https://github.com/leesharma/rescuetime/compare/v0.3.3...v0.4.0
+[v0.3.3]: https://github.com/leesharma/rescuetime/compare/v0.3.2...v0.3.3
+[v0.3.2]: https://github.com/leesharma/rescuetime/compare/v0.3.1...v0.3.2
+[v0.3.1]: https://github.com/leesharma/rescuetime/compare/v0.3.0...v0.3.1
+[v0.3.0]: https://github.com/leesharma/rescuetime/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/leesharma/rescuetime/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/leesharma/rescuetime/commits/v0.1.0