harvest-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f62238a0554a995b3f835926dadec05a7153991a147a555698f137212f07ffa
+  data.tar.gz: ac387031f0d107b762a673d6e3f94c4f48e0fa52e6ff244deb6dd127c6e196a2
+SHA512:
+  metadata.gz: e648a14b3fa5752b94ab3e760bad5297fc59a1663de73adbc78234c01b1d428d86dff8c22331fffea632375201cda2052915215e713e95a2d0c5fc8970628658
+  data.tar.gz: 56a9bdc24a5393c79f6be30f41c4eae411e2bbdb1c13d5dfd404fa39d967d30fd3d3d03169d0a7b8c249bff558b91e1ef6464d6c12b193726a55cfb2d4c91178

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/Gemfile.lock
+
+# Used by dotenv library to load environment variables.
+.env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:2.4.2
+
+# app dependencies
+RUN apt-get update -qq && apt-get install -y build-essential
+
+ENV APP_HOME /opt/harvest_api
+RUN mkdir -p $APP_HOME
+WORKDIR $APP_HOME
+
+# ADD . $APP_HOME/
+
+# RUN bundle

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in harvest-api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Zachary Chai
+
+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,32 @@
+# Harvest API
+A ruby wrapper for Harvest v2 API http://www.getharvest.com/api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'harvest-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install harvest-api
+
+## Usage
+
+```ruby
+# Create client with authentication credentials
+client = Harvest.client(access_token: 'd7f9bjnf9', account_id: '183950', user_agent: 'HarvestAPI (yourname@example.com)')
+
+# Fetch the authenticated user
+client.users.me
+```
+
+## Supported features
+
+- Time Entries

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "harvest"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,14 @@
+version: '3'
+services:
+  gem:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - .:/opt/harvest_api
+      - gem_cache:/usr/local/bundle
+    command: bash
+
+volumes:
+  gem_cache:
+    driver: local

data/exe/harvest-api

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "harvest"

data/harvest-api.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "harvest/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "harvest-api"
+  spec.version       = Harvest::VERSION
+  spec.authors       = ["Zachary Chai"]
+  spec.email         = ["zachary.chai@outlook.com"]
+
+  spec.summary       = %q{A ruby wrapper for Harvest v2 API http://www.getharvest.com/api}
+  spec.description   = %q{A ruby wrapper for Harvest v2 API http://www.getharvest.com/api}
+  spec.homepage      = "https://github.com/zach-chai/harvest-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_dependency "faraday", "~> 0.13"
+  spec.add_dependency "faraday_middleware", "~> 0.12"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "byebug"
+end

data/lib/harvest.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'byebug'
+
+require 'harvest/version'
+require 'harvest/client'
+require 'harvest/request'
+require 'harvest/response'
+
+require 'harvest/resource/base'
+require 'harvest/resource/time_entry'
+require 'harvest/resource/user'
+
+module Harvest
+  class << self
+    def client *args
+      Client.new *args
+    end
+  end
+end

data/lib/harvest/client.rb

@@ -0,0 +1,35 @@
+require 'harvest/client/users'
+require 'harvest/client/time_entries'
+
+module Harvest
+  class Client
+    include TimeEntries
+    include Users
+
+    BASE_URL = 'https://api.harvestapp.com/v2'.freeze
+
+    attr_reader :connection
+
+    def initialize access_token: nil, account_id: nil, user_agent: nil
+      @connection = Faraday.new(url: BASE_URL) do |conn|
+        conn.request :json
+        conn.request :oauth2, access_token, token_type: :bearer
+
+        conn.headers = {
+          'Harvest-Account-Id' => account_id,
+          'User-Agent' => user_agent
+        }
+
+        conn.response :json, :content_type => /\bjson$/
+
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end
+
+
+# curl -H "Authorization: Bearer $ACCESS_TOKEN" \
+#      -H "Harvest-Account-Id: $ACCOUNT_ID" \
+#      -H "User-Agent: MyApp (yourname@example.com)" \
+#      https://api.harvestapp.com/v2/users/me

data/lib/harvest/client/base_api.rb

@@ -0,0 +1,13 @@
+module Harvest
+  class Client
+    class BaseApi
+      def initialize conn
+        @connection = conn
+      end
+
+      def build_url path = nil
+        [collection_name, path].join('/')
+      end
+    end
+  end
+end

data/lib/harvest/client/helpers/all.rb

@@ -0,0 +1,16 @@
+module Harvest
+  class Client
+    module Helpers
+      module All
+        def all params = {}
+          res = Request.new(@connection, build_url, params).get
+          if res.success?
+            res.body[collection_name].map { |te| resource.new(te) }
+          else
+            res.error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/harvest/client/helpers/create.rb

@@ -0,0 +1,16 @@
+module Harvest
+  class Client
+    module Helpers
+      module Create
+        def create body
+          res = Request.new(@connection, build_url, body).post
+          if res.success?
+            resource.new(res.body)
+          else
+            res.error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/harvest/client/helpers/delete.rb

@@ -0,0 +1,16 @@
+module Harvest
+  class Client
+    module Helpers
+      module Delete
+        def delete id
+          res = Request.new(@connection, build_url(id)).delete
+          if res.success?
+            resource.new(res.body)
+          else
+            res.error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/harvest/client/helpers/find.rb

@@ -0,0 +1,16 @@
+module Harvest
+  class Client
+    module Helpers
+      module Find
+        def find id
+          res = Request.new(@connection, build_url(id)).get
+          if res.success?
+            resource.new(res.body)
+          else
+            res.error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/harvest/client/helpers/update.rb

@@ -0,0 +1,16 @@
+module Harvest
+  class Client
+    module Helpers
+      module Update
+        def update id, body
+          res = Request.new(@connection, build_url(id), body).patch
+          if res.success?
+            resource.new(res.body)
+          else
+            res.error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/harvest/client/time_entries.rb

@@ -0,0 +1,32 @@
+require 'harvest/client/base_api'
+require 'harvest/client/helpers/all'
+require 'harvest/client/helpers/find'
+require 'harvest/client/helpers/create'
+require 'harvest/client/helpers/update'
+require 'harvest/client/helpers/delete'
+
+module Harvest
+  class Client
+    module TimeEntries
+      def time_entries
+        TimeEntriesApi.new(connection)
+      end
+
+      class TimeEntriesApi < BaseApi
+        include Helpers::All
+        include Helpers::Find
+        include Helpers::Create
+        include Helpers::Update
+        include Helpers::Delete
+
+        def resource
+          Resource::TimeEntry
+        end
+
+        def collection_name
+          'time_entries'
+        end
+      end
+    end
+  end
+end

data/lib/harvest/client/users.rb

@@ -0,0 +1,37 @@
+require 'harvest/client/base_api'
+require 'harvest/client/helpers/all'
+require 'harvest/client/helpers/find'
+require 'harvest/client/helpers/create'
+
+module Harvest
+  class Client
+    module Users
+      def users
+        UsersApi.new(connection)
+      end
+
+      class UsersApi < BaseApi
+        include Helpers::All
+        include Helpers::Find
+        include Helpers::Create
+
+        def me
+          res = Request.new(@connection, build_url('me')).get
+          if res.success?
+            resource.new(res.body)
+          else
+            res.error
+          end
+        end
+
+        def resource
+          Resource::User
+        end
+
+        def collection_name
+          'users'
+        end
+      end
+    end
+  end
+end

data/lib/harvest/request.rb

@@ -0,0 +1,41 @@
+module Harvest
+  class Request
+    attr_accessor :resource, :params
+
+    def initialize conn, path, params = {}
+      @connection = conn
+      @path = path
+      @params = params
+    end
+
+    def get
+      res = @connection.get do |req|
+              req.url @path, @params
+            end
+      Response.new res
+    end
+
+    def post
+      res = @connection.post do |req|
+              req.url @path
+              req.body = @params
+            end
+      Response.new res
+    end
+
+    def patch
+      res = @connection.patch do |req|
+              req.url @path
+              req.body = @params
+            end
+      Response.new res
+    end
+
+    def delete
+      res = @connection.delete do |req|
+        req.url @path
+      end
+      Response.new res
+    end
+  end
+end

data/lib/harvest/resource/base.rb

@@ -0,0 +1,27 @@
+module Harvest
+  module Resource
+    class Base
+      class << self
+        def attributes *attrs
+          if attrs.any?
+            @@attributes = attrs
+            attr_reader *attrs
+            self
+          else
+            @@attributes
+          end
+        end
+      end
+
+      def initialize attr_map
+        attr_map.each do |attribute, value|
+          instance_variable_set("@#{attribute}", value)
+        end
+      end
+
+      def attributes
+        self.class.attributes
+      end
+    end
+  end
+end

data/lib/harvest/resource/time_entry.rb

@@ -0,0 +1,32 @@
+module Harvest
+  module Resource
+    class TimeEntry < Base
+      attributes  :id,
+                  :spent_date,
+                  :user,
+                  :user_assignment,
+                  :client,
+                  :project,
+                  :task,
+                  :task_assignment,
+                  :external_reference,
+                  :invoice,
+                  :hours,
+                  :notes,
+                  :is_locked,
+                  :locked_reason,
+                  :is_closed,
+                  :is_billed,
+                  :timer_started_at,
+                  :started_time,
+                  :ended_time,
+                  :is_running,
+                  :billable,
+                  :budgeted,
+                  :billable_rate,
+                  :cost_rate,
+                  :created_at,
+                  :updated_at
+    end
+  end
+end

data/lib/harvest/resource/user.rb

@@ -0,0 +1,27 @@
+module Harvest
+  module Resource
+    class User < Base
+      attributes :id,
+                 :first_name,
+                 :last_name,
+                 :email,
+                 :telephone,
+                 :timezone,
+                 :has_access_to_all_future_projects,
+                 :is_contractor,
+                 :is_admin,
+                 :is_project_manager,
+                 :can_see_rates,
+                 :can_create_projects,
+                 :can_create_invoices,
+                 :is_active,
+                 :weekly_capacity,
+                 :default_hourly_rate,
+                 :cost_rate,
+                 :roles,
+                 :avatar_url,
+                 :created_at,
+                 :updated_at
+    end
+  end
+end

data/lib/harvest/response.rb

@@ -0,0 +1,16 @@
+module Harvest
+  class Response
+    extend Forwardable
+    
+    def initialize res
+      @res = res
+    end
+
+    def error
+      return if success?
+      body
+    end
+
+    def_delegators :@res, :success?, :status, :body
+  end
+end

data/lib/harvest/version.rb

@@ -0,0 +1,3 @@
+module Harvest
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: harvest-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zachary Chai
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: A ruby wrapper for Harvest v2 API http://www.getharvest.com/api
+email:
+- zachary.chai@outlook.com
+executables:
+- harvest-api
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Dockerfile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- exe/harvest-api
+- harvest-api.gemspec
+- lib/harvest.rb
+- lib/harvest/client.rb
+- lib/harvest/client/base_api.rb
+- lib/harvest/client/helpers/all.rb
+- lib/harvest/client/helpers/create.rb
+- lib/harvest/client/helpers/delete.rb
+- lib/harvest/client/helpers/find.rb
+- lib/harvest/client/helpers/update.rb
+- lib/harvest/client/time_entries.rb
+- lib/harvest/client/users.rb
+- lib/harvest/request.rb
+- lib/harvest/resource/base.rb
+- lib/harvest/resource/time_entry.rb
+- lib/harvest/resource/user.rb
+- lib/harvest/response.rb
+- lib/harvest/version.rb
+homepage: https://github.com/zach-chai/harvest-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.2
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for Harvest v2 API http://www.getharvest.com/api
+test_files: []