rescue_time_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7bcda200ab03a2e5969cb1a6e4d733431733e44
+  data.tar.gz: 92a9be4d4fd9189d779602475f79bc3ed41b45f2
+SHA512:
+  metadata.gz: c96514b0602401c49b5512d835a898f48358c1d99e6c7f0c6bc95c4a87652f7674f3b45f64fb05352307127aee16dec927f074a26ddc9b990dcd915e106dcd5d
+  data.tar.gz: 466ddcc8aa15531c4b92956e408f00dc14c45d78bdeea21f5820f6a3354f0df3bc4a1f562fccd706f892f97692bf112ebdf4d6f41104ebba1e7174dc4e18f526

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rescue_time_api.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Daniel Luxemburg
+
+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,97 @@
+# RescueTimeApi
+
+Ruby wrapper for the [RescueTime data API](https://www.rescuetime.com/anapi/setup/documentation)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rescue_time_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rescue_time_api
+
+## Usage
+
+You'll need a key from RescueTime's [API Key Management](https://www.rescuetime.com/anapi/manage) page. Once you've got one, create a client instance like this:
+
+```ruby
+client = RescueTimeApi::Client.new(key: 'notanactualkey123456')
+```
+
+Make requests using the parameters described in [RescueTime's documentation](https://www.rescuetime.com/anapi/setup/documentation). Pass parameters as a hash with either strings or symbols as keys.
+
+```ruby
+client.request({
+  prespective: 'interval',
+  resolution_time: 'day'
+})
+```
+
+The only transformations applied to the parameter hash is to add the `format` value (json), the `key` value, and to change any date type parameters into a correctly formatted day string (YYYY-MM-DD). So this will work:
+
+```ruby
+client.request({
+  prespective: 'interval',
+  restrict_begin: DateTime.now
+})
+```
+
+The `#request` method returns a `RescueTimeApi::Response` object. Use its `#rows` method to access the returned data as an array of hashes with simplified keys:
+
+```ruby
+RescueTimeApi::Client > request({}).rows
+=> [
+    {"rank"=>1,
+    "seconds"=>5887,
+    "people"=>1,
+    "activity"=>"sublime text",
+    "categoty"=>"Editing & IDEs",
+    "productivity"=>2},
+   {"rank"=>2,
+    "seconds"=>5668,
+    "people"=>1,
+    "activity"=>"iTerm",
+    "categoty"=>"Systems Operations",
+    "productivity"=>2},
+   {"rank"=>3,
+    "seconds"=>4131,
+    "people"=>1,
+    "activity"=>"github.com",
+    "categoty"=>"General Software Development",
+    "productivity"=>1},
+    <...>
+  ]
+```
+
+`date` keys are returned as `DateTime`s.
+
+## REPL
+
+You can launch a [Pry](http://pryrepl.org/) REPL to play with the client interactively:
+
+  $ rescue_time_api notanactualkey123456
+
+```ruby
+
+RescueTimeApi::Client >
+RescueTimeApi::Client > request({prespective: 'interval'})
+=> #<RescueTimeApi::Response:0x007f976b143e58...
+```
+
+## Tests
+
+They're in RSpec.
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/rescue_time_api

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+
+unless ARGV[0]
+  puts "Must supply an API key as first argument"
+  exit
+end
+
+require 'rescue_time_api'
+
+client = RescueTimeApi::Client.new(key: ARGV[0])
+
+require 'pry'
+
+Pry.start(client, quiet: true, prompt: [ proc { "RescueTimeApi::Client > " } ])

data/lib/rescue_time_api/client.rb

@@ -0,0 +1,60 @@
+require 'date'
+require 'faraday'
+require 'faraday_middleware'
+
+module RescueTimeApi
+  class Client
+
+    attr_accessor :key, :host, :base_path
+
+    def initialize(options)
+      @key = options.fetch(:key)
+      @host = options.fetch(:host,"www.rescuetime.com")
+      @base_path = options.fetch(:base_path,"/anapi/data")
+    end
+
+    def connection
+      @connection ||= get_connection
+    end
+
+    def get_connection
+      Faraday.new(:url => "https://#{host}") do |conn|
+        conn.request    :json
+        conn.response   :json, :content_type => /\bjson$/
+        conn.adapter    Faraday.default_adapter
+      end
+    end
+
+    def request(params)
+      params = format_params(params)
+      Response.new(run_request(params))
+    end
+
+    def run_request(params)
+      connection.get(base_path,params.merge(default_params))
+    end
+
+    def current_user_name
+      request({perspective: 'member'}).rows.first['person']
+    end
+
+    def default_params
+      {key: key, format: 'json'}
+    end
+
+    def format_params(params)
+      time_keys.each do |key|
+        if params[key] && params[key].respond_to?(:to_date)
+          params[key] = params[key].to_date.to_s
+        end
+      end
+      params
+    end
+
+    def time_keys
+      keys = ['re','restrict_end','rb','restrict_begin']
+      return keys + keys.map(&:to_sym)
+    end
+
+  end
+end

data/lib/rescue_time_api/response.rb

@@ -0,0 +1,46 @@
+require 'date'
+require 'forwardable'
+
+module RescueTimeApi
+  class Response
+
+      attr_accessor :response
+      extend Forwardable
+      def_delegators :@response, :body, :headers
+
+      def initialize(response)
+        @response = response
+      end
+
+      def row_headers
+        @row_headers ||= body['row_headers'].map { |row_name| key_mapping[row_name] }
+      end
+
+      def rows
+        @rows ||= body["rows"].map { |row| map_row(row) }
+      end
+
+      def map_row(row)
+        mapped = Hash[row_headers.zip(row)]
+        mapped['date'] = DateTime.parse(mapped['date']) if mapped['date']
+        ['second','rank','people','productivity'].each do |key|
+          mapped[key] = mapped[key].to_i if mapped[key]
+        end
+        mapped
+      end
+
+      def key_mapping
+        {
+          "Person" => 'person',
+          "Rank" => 'rank',
+          "Time Spent (seconds)" => 'seconds',
+          "Number of People" => 'people',
+          "Activity" => 'activity',
+          "Category" => 'categoty',
+          "Productivity" => 'productivity',
+          "Date" => "date"
+        }
+      end
+
+  end
+end

data/lib/rescue_time_api/version.rb

@@ -0,0 +1,3 @@
+module RescueTimeApi
+  VERSION = "0.0.1"
+end

data/lib/rescue_time_api.rb

@@ -0,0 +1,7 @@
+require "rescue_time_api/version"
+require "rescue_time_api/client"
+require "rescue_time_api/response"
+
+
+module RescueTimeApi
+end

data/rescue_time_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rescue_time_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rescue_time_api"
+  spec.version       = RescueTimeApi::VERSION
+  spec.authors       = ["Daniel Luxemburg"]
+  spec.email         = ["daniel.luxemburg@gmail.com"]
+  spec.description   = %q{Ruby wrapper for the RescueTime data API}
+  spec.summary       = %q{Ruby wrapper for the RescueTime data API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "pry"
+  spec.add_dependency "faraday", "~> 0.8.8"
+  spec.add_dependency "faraday_middleware"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+end

data/spec/rescue_time_api/client_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe RescueTimeApi::Client do
+
+  let(:key){ "B63M14zPRjDUHjN6TNNVydDqe_qGgxCaqUycoIWE" }
+  let(:client) { RescueTimeApi::Client.new(key: key) }
+  let(:response_data){
+    double(body: {
+        'row_headers' => [
+          "Rank",
+          "Time Spent (seconds)",
+          "Number of People",
+          "Activity",
+          "Category",
+          "Productivity"
+        ],
+        'rows' => [
+          [1, 5887, 1, "sublime text", "Editing & IDEs", 2],
+          [2, 5668, 1, "iTerm", "Systems Operations", 2],
+          [3, 4131, 1, "github.com", "General Software Development", 1]
+        ]
+      })
+  }
+
+  context ".new" do
+
+    it "initializes with a key" do
+      client = RescueTimeApi::Client.new(key: key)
+      expect(client.key).to eq(key)
+    end
+
+    it "raises an error without a key" do
+      expect {
+        client = RescueTimeApi::Client.new({})
+      }.to raise_error(KeyError)
+    end
+
+    it "knows the host and path by default" do
+      client = RescueTimeApi::Client.new(key: key)
+      expect(client.host).to eq("www.rescuetime.com")
+      expect(client.base_path).to eq("/anapi/data")
+    end
+
+  end
+
+  context "#connection" do
+
+    let(:client) { RescueTimeApi::Client.new(key: key) }
+
+    it "creates a @connection" do
+      expect(client.instance_variable_get(:@connection)).to eq(nil)
+      client.connection
+      expect(client.instance_variable_get(:@connection)).to be_a(Faraday::Connection)
+    end
+
+  end
+
+  context "#run_request" do
+
+    it "sends the request to the connection, adding the base path and default parameters" do
+      connection = double()
+      expect(connection).to receive(:get).with("/anapi/data", {
+        key: key,
+        format: 'json',
+        perspective: 'interval'
+      })
+      client.stub(:connection).and_return(connection)
+      client.run_request({perspective: 'interval'})
+    end
+
+  end
+
+  context "#request" do
+
+    it "sends the request to the #run_request, formatting any date parameters" do
+      stamp = DateTime.now.strftime('%Y-%m-%d')
+
+      expect(client).to receive(:run_request).with({
+        re: stamp
+      })
+
+      client.request({re: DateTime.now})
+
+    end
+
+    it "returns a Response object" do
+
+      client.stub(:run_request).and_return(response_data)
+      expect(client.request({})).to be_a(RescueTimeApi::Response)
+      expect(client.request({}).rows.count).to eq(3)
+
+    end
+
+  end
+
+
+end

data/spec/rescue_time_api/response_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe RescueTimeApi::Response do
+
+  let(:response_headers){
+    double()
+  }
+  let(:response_body){
+    {
+        'row_headers' => [
+          "Rank",
+          "Time Spent (seconds)",
+          "Number of People",
+          "Activity",
+          "Category",
+          "Productivity"
+        ],
+        'rows' => [
+          [1, 5887, 1, "sublime text", "Editing & IDEs", 2],
+          [2, 5668, 1, "iTerm", "Systems Operations", 2],
+          [3, 4131, 1, "github.com", "General Software Development", 1]
+        ]
+      }
+  }
+  let(:response_body2){
+    {
+        'row_headers' => [
+           "Date",
+           "Time Spent (seconds)",
+           "Number of People",
+           "Activity",
+           "Category",
+           "Productivity"
+         ],
+        'rows' => [
+          [
+            "2013-10-14T00:00:00",
+            136,
+            1,
+            "github.com",
+            "General Software Development",
+            1
+          ]
+        ]
+      }
+  }
+  let(:response_object){
+    double(body: response_body, headers: response_headers)
+  }
+  let(:response_object2){
+    double(body: response_body2, headers: response_headers)
+  }
+  let(:response){ RescueTimeApi::Response.new(response_object) }
+  let(:response2){ RescueTimeApi::Response.new(response_object2) }
+
+  it "maps raw response body to an array of hashes" do
+
+    expect(response.rows).to be_a(Array)
+    expect(response.rows.map(&:class)).to eq [Hash,Hash,Hash]
+
+  end
+
+  it "ensures integer values are Integers" do
+
+    expect(response.rows.first['rank']).to be_a(Integer)
+    expect(response.rows.first['seconds']).to be_a(Integer)
+    expect(response.rows.first['people']).to be_a(Integer)
+    expect(response.rows.first['productivity']).to be_a(Integer)
+
+  end
+
+  it "ensures date values are DateTimes" do
+
+    expect(response2.rows.first['date']).to be_a(DateTime)
+
+  end
+
+  it "exposes the original reponse object" do
+    expect(response.response).to eq(response_object)
+  end
+
+  it "exposes the original headers object" do
+    expect(response.headers).to eq(response_headers)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "bundler"
+Bundler.require(:default,:development)
+
+Dir[File.expand_path('../support/*.rb', __FILE__)].each {|f| require f}
+
+RSpec.configure do |config|
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run_excluding :live unless ENV['LIVE']
+
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: rescue_time_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Luxemburg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: 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: rspec
+  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: guard-rspec
+  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'
+description: Ruby wrapper for the RescueTime data API
+email:
+- daniel.luxemburg@gmail.com
+executables:
+- rescue_time_api
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rescue_time_api
+- lib/rescue_time_api.rb
+- lib/rescue_time_api/client.rb
+- lib/rescue_time_api/response.rb
+- lib/rescue_time_api/version.rb
+- rescue_time_api.gemspec
+- spec/rescue_time_api/client_spec.rb
+- spec/rescue_time_api/response_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the RescueTime data API
+test_files:
+- spec/rescue_time_api/client_spec.rb
+- spec/rescue_time_api/response_spec.rb
+- spec/spec_helper.rb