forecasted 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30f437539e2597b97dc9ecf225d2d73e3eba64fa
+  data.tar.gz: 321d7c0c82f628970302c1d891648ecf1e91587a
+SHA512:
+  metadata.gz: 1c3a5887aa6a2fa90863485bf6df8709b210bdecf8fb806a065bbd97558f841f2e0b762d2d29a1bf173276de62fc0d9dd9ebde04b8a4f81d70b794554083237e
+  data.tar.gz: 4fd50309e57461e1bd9559ae240809419d15cf5d65bf1bb1d788e6b283ebbfc311b1714dfa46363fa63b6354602ff95e77657e0f19b1801081c0ab32ec59daf2

data/.document

@@ -0,0 +1,3 @@
+README.md
+lib/**/*.rb
+MIT-LICENSE

data/.gitignore

@@ -0,0 +1,39 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+doc
+.yardoc
+.byebug_history
+
+## PROJECT::SPECIFIC
+features/support/forecast_credentials.yml
+spec/support/forecast_credentials.yml
+.cassettes
+.rbx
+
+## RUBYGEMS
+*.gem
+Gemfile.lock
+.bundle
+vendor/bundle
+
+tmp
+
+## custom ignores
+weston.md

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format=documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  # - 2.0.0
+  # - 2.1
+  - 2.2.4
+  - 2.3.1
+  # - ruby-head
+
+install:
+  - bundle install --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle} --without development
+
+script:
+  - bundle exec rspec spec/forecast

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'bundler', '>= 1.6.2'
+  gem 'rake'
+  gem 'rspec', '~> 3'
+  gem 'jruby-openssl', :platform => [:jruby], :require => false
+  gem 'webmock'
+  gem 'vcr'
+  gem 'factory_girl'
+end
+
+group :development do
+  gem 'byebug'
+  gem 'yard'
+  gem 'redcarpet'
+end

data/HISTORY.md

@@ -0,0 +1,19 @@
+## 0.0.1
+  * projects:
+    * index
+    * index with query params
+    * find
+    * find_by_harvest_id
+  * assignments:
+    * index
+    * index with query params
+    * find
+    * by_project
+    * last_by_project
+    * sum_allocation_seconds
+  * aggreagates:
+    * future_scheduled_hours_after
+    * remaining_budgeted_hours
+
+
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Weston Platter
+
+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,109 @@
+# Forecasted: A Ruby (Harvest)Forecast API
+
+[![Build Status](https://travis-ci.org/westonplatter/forecasted.svg?branch=master)](https://travis-ci.org/westonplatter/forecasted)
+
+Note: I copy+pasted the API Client structure from
+[from https://github.com/zmoazeni/harvested](from https://github.com/zmoazeni/harvested).
+
+A Ruby wrapper for the [Forecast (unofficial) API](https://forecastapp.com/).
+
+## Installation
+
+For the time being, add this to your gem file,
+
+    gem 'forecasted', github: 'westonplatter/forecasted'
+
+I'll push a version to rubygems when the API endpoints are developed.
+
+## Examples
+<!--
+```ruby
+harvest = Harvest.client(subdomain: 'yoursubdomain', username: 'yourusername', password: 'yourpassword')
+harvest.projects.all   # list out projects
+
+client = Harvest::Client.new(:name => "Billable Company LTD.")
+client = harvest.clients.create(client)
+harvest.clients.find(client.id) # returns a Harvest::Client
+```
+
+You can also pass query options in as the last parameter on any object's `all` finder
+method, for example to find all the projects for client ID 12345:
+
+```ruby
+harvest = Harvest.client(subdomain: 'yoursubdomain', username: 'yourusername', password: 'yourpassword')
+harvest.projects.all(nil, :client => 12345)
+```
+
+Note: the first parameter is a User ID field that is optional, but needs to be specified
+as nil if not included.
+
+You can pass in any hash of query attributes you wish as per the
+[Harvest API](http://www.getharvest.com/api) page.
+
+You can find more examples in `/examples` and in the documentation for Harvest::Base
+ -->
+## Permissions
+<!--
+For most operations you need to be an Admin on the Harvest account. You can do a few select things as a normal user or a project manager, but you will likely get errors.
+
+## Hardy Client
+
+The team at Harvest built a great API, but there are always dangers in writing code that depends on an API. For example: HTTP Timeouts, Occasional Bad Gateways, and Rate Limiting issues need to be accounted for.
+
+Using `Harvested#client` your code needs to handle all these situations. However you can also use `Harvested#hardy_client` which will retry errors and wait for Rate Limit resets.
+
+```ruby
+harvest = Harvest.hardy_client(subdomain: 'yoursubdomain', username: 'yourusername', password: 'yourpassword')
+harvest.projects.all   # This will wait for the Rate Limit reset if you have gone over your limit
+```
+ -->
+## Ruby support
+
+<!-- Harvested's tests currently support Ruby version 2.0+
+
+## Links
+
+* [Harvested Documentation](http://rdoc.info/projects/zmoazeni/harvested)
+* [Harvest API Documentation](http://www.getharvest.com/api)
+* [Source Code for Harvested](http://github.com/zmoazeni/harvested)
+
+## Who are you? ##
+
+My name is [Zach Moazeni](https://twitter.com/zmoazeni). I work for [an
+awesome company](http://www.getharvest.com/). And [we're
+hiring!](http://www.getharvest.com/careers) -->
+
+## How to Contribute
+
+<!-- If you find what looks like a bug:
+
+1. Check the GitHub issue tracker to see if anyone else has had the same issue.
+http://github.com/westonplatter/harvested/issues/
+2. If you don’t see anything, create an issue with information on how to
+reproduce it.
+
+If you want to contribute an enhancement or a fix:
+
+1. Fork the project on github http://github.com/westonplatter/harvested
+2. Make your changes with tests
+3. Commit the changes without messing with the Rakefile, or Version
+4. Make an entry to HISTORY.md
+5. Send me a pull request
+
+Note on running tests: most specs run against a live Forecast account. To run
+the suite, sign up for a free trial account and fill out
+`/spec/support/harvest_credentials.yml` *(a
+sample harvest_credentials.example.yml has been included)*.
+
+**DO NOT USE YOUR NORMAL CREDENTIALS IN `/spec/support/harvest_credentials.yml`!!!**
+The test suite blasts all the data before running (similiar to DatabaseCleaner).
+
+The tests use [VCR](https://github.com/myronmarston/vcr) to cache the API
+responses. This is a great boon for running the tests offline. While uncommon,
+sometimes the Harvest API will send an erroneous response, VCR will cache it,
+and subsequent runs will use the incorrect cached response. In order to clear
+the cached responses, you can run the specs with the `VCR_REFRESH`
+environmental variable set to true (e.g. `VCR_REFRESH=true bundle exec rake
+spec`).
+
+ -->

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => %w(spec)
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+desc 'Removes all data on harvest'
+task 'clean_remote' do
+  # require 'harvested'
+  # require File.expand_path('../spec/support/harvested_helpers', __FILE__)
+  # HarvestedHelpers.clean_remote
+end

data/examples/basics.rb

@@ -0,0 +1,35 @@
+# require "harvested"
+
+# subdomain = 'yoursubdomain'
+# username = 'yourusername'
+# password = 'yourpassword'
+
+# harvest = Harvest.hardy_client(subdomain: subdomain, username: username, password: password)
+
+# # Print out all users, clients, and projects on the account
+# puts "Users:"
+# harvest.users.all.each {|u| p u }
+
+# puts "Clients:"
+# harvest.clients.all.each {|c| p c }
+
+# puts "Projects:"
+# harvest.projects.all.each {|project| p project }
+
+# # Create a Client add a Project to that Client, Add a Task to the Project, track some Time against the Project/Task, and then Run a report against all time I've submitted
+
+# client = Harvest::Client.new(name: 'SuprCorp')
+# client = harvest.clients.create(client)
+
+# project = Harvest::Project.new(name: 'SuprGlu', client_id: client.id, notes: 'Some notes about this project')
+# project = harvest.projects.create(project)
+
+# harvest.projects.create_task(project, 'Bottling Glue')
+# task_assignment = harvest.task_assignments.all(project).first
+
+# time_entry = Harvest::TimeEntry.new(notes: 'Bottled glue today', hours: 8, spent_at: "04/11/2010", project_id: project.id, task_id: task_assignment.task_id)
+# time_entry = harvest.time.create(time_entry)
+
+# entries = harvest.reports.time_by_project(project, Time.parse("04/11/2010"), Time.parse("04/12/2010"))
+# puts "Entries:"
+# entries.each {|e| p e}

data/examples/clear_account.rb

@@ -0,0 +1,28 @@
+# This is commented out because it can be very dangerous if run against a production account
+
+# require "harvested"
+#
+# subdomain = 'yoursubdomain'
+# username = 'yourusername'
+# password = 'yourpassword'
+#
+# api = Harvest.hardy_client(subdomain: subdomain, username: username, password: password)
+#
+# raise "Are you sure you want to do this? (comment out this exception if so)"
+#
+# api.users.all.each do |u|
+#   api.users.delete(u) if u.email != username
+# end
+# my_user = api.users.all.first
+#
+# api.reports.time_by_user(my_user, Time.parse('01/01/2000'), Time.now).each do |time|
+#   api.time.delete(time)
+# end
+#
+# api.reports.expenses_by_user(my_user, Time.parse('01/01/2000'), Time.now).each do |time|
+#   api.expenses.delete(time)
+# end
+#
+# %w(expenses expense_categories projects contacts clients tasks).each do |collection|
+#   api.send(collection).all.each {|m| api.send(collection).delete(m) }
+# end

data/examples/project_create_script.rb

@@ -0,0 +1,93 @@
+# # File: project_create_script.rb
+# # Date Created: 2012-10-08
+# # Author(s): Mark Rickert (mjar81@gmail.com) / Skookum Digital Works - http://skookum.com
+# #
+# # Description: This example script takes user input from the command line and
+# # creates a project based the selected options. It then assigns tasks from Harvest
+# # to the project based on an array. After the tasks are added, it addes all the
+# # currently active users to the project.
+
+# require "harvested"
+
+# subdomain = 'yoursubdomain'
+# username = 'yourusername'
+# password = 'yourpassword'
+
+# harvest = Harvest.hardy_client(subdomain: subdomain, username: username, password: password)
+
+# puts "\nPlease search for a client by typing part of their name:"
+# cname = gets.chomp
+
+# # Filter out all the clients that don't match the typed string
+# client_search_results = harvest.clients.all.select { |c| c.name.downcase.include?(cname) }
+
+# case client_search_results.length
+# when 0
+# 	puts "No client found.  Please try again.\n"
+# 	abort
+# when 1
+# 	# Result is exactly 1. We got the client.
+# 	client_index = 0
+# when 1..15
+# 	# Have the user select from a list of clients.
+# 	puts "Please select from the following results:\n"
+# 	client_search_results.each_with_index do |c, i|
+# 		puts "  #{i+1}. #{c.name}"
+# 	end
+
+# 	client_index = gets.chomp.to_i - 1
+# else
+# 	puts "Too many client matches. Please try a more specific search term.\n"
+# 	abort
+# end
+
+# client = client_search_results[client_index]
+
+# puts "\nClient found: #{client.name}\n"
+# puts "Please enter the project name:"
+# project_name = gets.chomp
+
+# puts "\nIs this project billable? (y/n)"
+# billable = gets.chomp.downcase == "y"
+
+# puts "\nAny project notes? (hit 'return' for none)"
+# notes = gets.chomp
+
+# puts "\nWhat sorts of tasks does this project need? Type \"p\" for project tasks or \"s\" for sales tasks.\n"
+# task_types = gets.chomp
+
+# # Determine what task list to use based on the project type.
+# if task_types.downcase == "p"
+# 	# These are names of tasks that should already exist in Harvest
+# 	use_tasks = ["Client Communication", "Planning", "Design", "Development", "Testing/QA", "Documentation", "Deployment"]
+# else
+# 	use_tasks = ["Sales Calls", "Client Meetings", "Travel", "Estimating"]
+# end
+
+# # Filter the list of actual tasks we want to add to the project.
+# tasks = harvest.tasks.all.select { |t| use_tasks.include?(t.name) }
+
+# # Create the project
+# puts "Creating new project: \"#{project_name}\" for client: #{client.name}\n"
+# project = Harvest::Project.new(name: project_name, client_id: client.id, billable: billable, notes: notes)
+# project = harvest.projects.create(project)
+
+# # Add all the project tasks to the project
+# tasks.each do |t|
+# 	puts "  Adding Task: #{t.name}"
+# 	task_assignment = Harvest::TaskAssignment.new(task_id: t.id, project_id: project.id)
+# 	task_assignment = harvest.task_assignments.create(task_assignment)
+# end
+
+# puts
+# # Add every active user to the project.
+# harvest.users.all.each do |u|
+# 	next unless u.is_active?
+
+# 	puts "  Adding User: #{u.first_name} #{u.last_name}"
+# 	user_assignment = Harvest::UserAssignment.new(user_id: u.id, project_id: project.id)
+# 	harvest.user_assignments.create(user_assignment)
+# end
+
+# puts "\nProject successfully created."
+# puts "You can find the project here: http://#{subdomain}.harvestapp.com/projects/#{project.id}/edit\n\n"

data/examples/task_assignments.rb

@@ -0,0 +1,27 @@
+# require "harvested"
+
+# subdomain = 'yoursubdomain'
+# username = 'yourusername'
+# password = 'yourpassword'
+
+# harvest = Harvest.hardy_client(subdomain: subdomain, username: username, password: password)
+
+# # Create a Client add a Project to that Client
+
+# client = Harvest::Client.new(name: 'SuprCorp')
+# client = harvest.clients.create(client)
+
+# project = Harvest::Project.new(name: 'SuprGlu', client_id: client.id, notes: 'Some notes about this project')
+# project = harvest.projects.create(project)
+
+# # You can create an assign a task in one call
+# harvest.projects.create_task(project, 'Bottling Glue')
+# puts "Assigned the task 'Bottling Glue' to the project 'SuprGlu'"
+
+# # You can explicitly create the task and then assign it
+# task = Harvest::Task.new(name: 'Packaging Glue', hourly_rate: 30, billable: true)
+# task = harvest.tasks.create(task)
+
+# task_assignment = Harvest::TaskAssignment.new(task_id: task.id, project_id: project.id)
+# task_assignment = harvest.task_assignments.create(task_assignment)
+# puts "Assigned the task 'Packaging Glue' to the project 'SuprGlu'"

data/examples/user_assignments.rb

@@ -0,0 +1,24 @@
+# require "harvested"
+
+# subdomain = 'yoursubdomain'
+# username = 'userusername'
+# password = 'yourpassword'
+
+# harvest = Harvest.hardy_client(subdomain: subdomain, username: username, password: password)
+
+# # Create a Client, Project, and a User then assign that User to that Project
+
+# client = Harvest::Client.new(name: 'SuprCorp')
+# client = harvest.clients.create(client)
+
+# project = Harvest::Project.new(name: 'SuprGlu', client_id: client.id, notes: 'Some notes about this project')
+# project = harvest.projects.create(project)
+
+# harvest.projects.create_task(project, 'Bottling Glue')
+
+# user = Harvest::User.new(first_name: 'Jane', last_name: 'Doe', email: 'jane@doe.com', timezone: :est, password: 'secure')
+# user = harvest.users.create(user)
+
+# user_assignment = Harvest::UserAssignment.new(user_id: user.id, project_id: project.id)
+# harvest.user_assignments.create(user_assignment)
+# puts 'Assigned Jane Doe to the project "SuprGlu"'

data/forecasted.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'forecast/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "forecasted"
+  spec.version       = Forecast::VERSION
+  spec.authors       = ["Weston Platter"]
+  spec.summary       = "A Ruby Wrapper for the HarvestForecast (unofficial) API"
+  spec.homepage      = "http://github.com/westonplater/forecasted"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.required_ruby_version = '>= 2.0'
+
+  spec.add_runtime_dependency('httparty')
+  spec.add_runtime_dependency('hashie')
+  spec.add_runtime_dependency('json')
+  spec.add_runtime_dependency('business_time')
+end

data/lib/ext/array.rb

@@ -0,0 +1,52 @@
+# Shamelessly ripped from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/array/wrap.rb
+
+unless Array.respond_to?(:wrap)
+  class Array
+    # Wraps its argument in an array unless it is already an array (or array-like).
+    #
+    # Specifically:
+    #
+    # * If the argument is +nil+ an empty list is returned.
+    # * Otherwise, if the argument responds to +to_ary+ it is invoked, and its result returned.
+    # * Otherwise, returns an array with the argument as its single element.
+    #
+    #   Array.wrap(nil)       # => []
+    #   Array.wrap([1, 2, 3]) # => [1, 2, 3]
+    #   Array.wrap(0)         # => [0]
+    #
+    # This method is similar in purpose to <tt>Kernel#Array</tt>, but there are some differences:
+    #
+    # * If the argument responds to +to_ary+ the method is invoked. <tt>Kernel#Array</tt>
+    # moves on to try +to_a+ if the returned value is +nil+, but <tt>Arraw.wrap</tt> returns
+    # such a +nil+ right away.
+    # * If the returned value from +to_ary+ is neither +nil+ nor an +Array+ object, <tt>Kernel#Array</tt>
+    # raises an exception, while <tt>Array.wrap</tt> does not, it just returns the value.
+    # * It does not call +to_a+ on the argument, though special-cases +nil+ to return an empty array.
+    #
+    # The last point is particularly worth comparing for some enumerables:
+    #
+    #   Array(:foo => :bar)      # => [[:foo, :bar]]
+    #   Array.wrap(:foo => :bar) # => [{:foo => :bar}]
+    #
+    #   Array("foo\nbar")        # => ["foo\n", "bar"], in Ruby 1.8
+    #   Array.wrap("foo\nbar")   # => ["foo\nbar"]
+    #
+    # There's also a related idiom that uses the splat operator:
+    #
+    #   [*object]
+    #
+    # which returns <tt>[nil]</tt> for +nil+, and calls to <tt>Array(object)</tt> otherwise.
+    #
+    # Thus, in this case the behavior is different for +nil+, and the differences with
+    # <tt>Kernel#Array</tt> explained above apply to the rest of +object+s.
+    def self.wrap(object)
+      if object.nil?
+        []
+      elsif object.respond_to?(:to_ary)
+        object.to_ary
+      else
+        [object]
+      end
+    end
+  end
+end

data/lib/ext/date.rb

@@ -0,0 +1,9 @@
+# Shamelessly ripped from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/date/conversions.rb
+
+unless ::Date.respond_to?(:to_time)
+  class ::Date
+    def to_time(*)
+      ::Time.utc(year, month, day)
+    end
+  end
+end

data/lib/ext/hash.rb

@@ -0,0 +1,17 @@
+# Shamelessly ripped from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/keys.rb
+
+unless Hash.respond_to?(:stringify_keys)
+  class Hash
+    # Return a new hash with all keys converted to strings.
+    def stringify_keys
+      dup.stringify_keys!
+    end
+    
+    def stringify_keys!
+      keys.each do |key|
+        self[key.to_s] = delete(key)
+      end
+      self
+    end
+  end
+end

data/lib/ext/time.rb

@@ -0,0 +1,5 @@
+unless Time.respond_to?(:to_time)
+  class Time
+    def to_time; self; end
+  end
+end

data/lib/forecast/aggregate.rb

@@ -0,0 +1,8 @@
+module Forecast
+
+  class Aggregate < Hashie::Mash
+    include Forecast::Model
+    api_path '/aggregate'
+  end
+
+end

data/lib/forecast/api/account.rb

@@ -0,0 +1,22 @@
+module Harvest
+  module API
+    
+    # API Methods to contain all account actions
+    class Account < Base
+      
+      # Returns the current rate limit information
+      # @return [Harvest::RateLimitStatus]
+      def rate_limit_status
+        response = request(:get, credentials, '/account/rate_limit_status')
+        Harvest::RateLimitStatus.parse(response.body).first
+      end
+      
+      # Returns the current logged in user
+      # @return [Harvest::User]
+      def who_am_i
+        response = request(:get, credentials, '/account/who_am_i')
+        Harvest::User.parse(response.body).first
+      end
+    end
+  end
+end

data/lib/forecast/api/aggregates.rb

@@ -0,0 +1,20 @@
+module Forecast
+  module API
+    class Aggregates < Base
+      api_model Forecast::Aggregate
+
+      def future_scheduled_hours_after(date_string, query={})
+        url = "#{api_model.api_path}/future_scheduled_hours/#{date_string}"
+        response = request(:get, credentials, url, :query => query)
+        api_model.parse(response.parsed_response)
+      end
+
+      def remaining_budgeted_hours(query={})
+        url = "#{api_model.api_path}/remaining_budgeted_hours"
+        response = request(:get, credentials, url, :query => query)
+        api_model.parse(response.parsed_response)
+      end
+
+    end
+  end
+end