harvest-ruby-v2 0.2.0

data/lib/harvest/resources/project_assignment.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param id [Integer]
+    #   Unique ID for the project assignment.
+    # @param is_active [Boolean]
+    #   Whether the project assignment is active or archived.
+    # @param is_project_manager [Boolean]
+    #   Determines if the user has Project Manager permissions for the project.
+    # @param use_default_rates [Boolean]
+    #   Determines which billable rate(s) will be used on the project for this
+    #   user when bill_by is People. When true, the project will use the user's
+    #   default billable rates. When false, the project will use the custom rate
+    #   defined on this user assignment.
+    # @param hourly_rate [decimal]
+    #   Custom rate used when the project's bill_by is People and use_default_rates is false.
+    # @param budget [decimal]
+    #   Budget used when the project's budget_by is person.
+    # @param created_at [DateTime]
+    #   Date and time the project assignment was created.
+    # @param updated_at [DateTime]
+    #   Date and time the project assignment was last updated.
+    # @param project [Struct]
+    #   An object containing the assigned project id, name, and code.
+    # @param client [Struct]
+    #   An object containing the project's client id and name.
+    # @param task_assignments [List]
+    #   Array of task assignment objects associated with the project.
+    ProjectAssignment = Struct.new(
+      'ProjectAssignment',
+      :id,
+      :is_project_manager,
+      :is_active,
+      :use_default_rates,
+      :budget,
+      :created_at,
+      :updated_at,
+      :hourly_rate,
+      :project,
+      :client,
+      :task_assignments,
+      keyword_init: true
+    )
+  end
+end

data/lib/harvest/resources/task.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param id [Integer]
+    #   Unique ID for the task.
+    # @param name [String]
+    #   The name of the task.
+    # @param billable_by_default [Boolean]
+    #   Used in determining whether default tasks should be marked billable when
+    #   creating a new project.
+    # @param default_hourly_rate [decimal]
+    #   The hourly rate to use for this task when it is added to a project.
+    # @param is_default [Boolean]
+    #   Whether this task should be automatically added to future projects.
+    # @param is_active [Boolean]
+    #   Whether this task is active or archived.
+    # @param created_at [DateTime]
+    #   Date and time the task was created.
+    # @param updated_at [DateTime]
+    #   Date and time the task was last updated.
+    Task = Struct.new(
+      'Task',
+      :id,
+      :name,
+      :billable_by_default,
+      :default_hourly_rate,
+      :is_default,
+      :is_active,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+  end
+end

data/lib/harvest/resources/task_assignment.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param id [Integer]
+    #   Unique ID for the task assignment.
+    # @param project [Struct]
+    #   An object containing the id, name, and code of the associated project.
+    # @param task [Struct]
+    #   An object containing the id and name of the associated task.
+    # @param is_active [Boolean]
+    #   Whether the task assignment is active or archived.
+    # @param billable [Boolean]
+    #   Whether the task assignment is billable or not. For example: if set to
+    #   true, all time tracked on this project for the associated task will be
+    #   marked as billable.
+    # @param hourly_rate [decimal]
+    #   Rate used when the project's bill_by is Tasks.
+    # @param budget [decimal]
+    #   Budget used when the project's budget_by is task or task_fees.
+    # @param created_at [DateTime]
+    #   Date and time the task assignment was created.
+    # @param updated_at [DateTime]
+    #   Date and time the task assignment was last updated.
+    TaskAssignment = Struct.new(
+      'TaskAssignment',
+      :id,
+      :billable,
+      :is_active,
+      :created_at,
+      :updated_at,
+      :hourly_rate,
+      :budget,
+      :task,
+      keyword_init: true
+    )
+  end
+end

data/lib/harvest/resources/timeentry.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param id [Integer]
+    #   Unique ID for the time entry.
+    # @param spent_date [Date]
+    #   Date of the time entry.
+    # @param user [Struct]
+    #   An object containing the id and name of the associated user.
+    # @param user_assignment [Struct]
+    #   A user assignment object of the associated user.
+    # @param client [Struct]
+    #   An object containing the id and name of the associated client.
+    # @param project [Struct]
+    #   An object containing the id and name of the associated project.
+    # @param task [Struct]
+    #   An object containing the id and name of the associated task.
+    # @param task_assignment [Struct]
+    #   A task assignment object of the associated task.
+    # @param external_reference [Struct]
+    #   An object containing the id, group_id, permalink, service, and
+    #   service_icon_url of the associated external reference.
+    # @param invoice [Struct]
+    #   Once the time entry has been invoiced, this field will include the
+    #   associated invoice's id and number.
+    # @param hours [decimal]
+    #   Number of (decimal time) hours tracked in this time entry.
+    # @param rounded_hours [decimal]
+    #   Number of (decimal time) hours tracked in this time entry used in summary
+    #   reports and invoices. This value is rounded according to the Time Rounding
+    #   setting in your Preferences.
+    # @param notes [String]
+    #   Notes attached to the time entry.
+    # @param is_locked [Boolean]
+    #   Whether or not the time entry has been locked.
+    # @param locked_reason [String]
+    #   Why the time entry has been locked.
+    # @param is_closed [Boolean]
+    #   Whether or not the time entry has been approved via Timesheet Approval.
+    # @param is_billed [Boolean]
+    #   Whether or not the time entry has been marked as invoiced.
+    # @param timer_started_at [DateTime]
+    #   Date and time the timer was started (if tracking by duration). Use the ISO 8601 Format.
+    # @param started_time [Time]
+    #   Time the time entry was started (if tracking by start/end times).
+    # @param ended_time [Time]
+    #   Time the time entry was ended (if tracking by start/end times).
+    # @param is_running [Boolean]
+    #   Whether or not the time entry is currently running.
+    # @param billable [Boolean]
+    #   Whether or not the time entry is billable.
+    # @param budgeted [Boolean]
+    #   Whether or not the time entry counts towards the project budget.
+    # @param billable_rate [decimal]
+    #   The billable rate for the time entry.
+    # @param cost_rate [decimal]
+    #   The cost rate for the time entry.
+    # @param created_at [DateTime]
+    #   Date and time the time entry was created. Use the ISO 8601 Format.
+    # @param updated_at [DateTime]
+    #   Date and time the time entry was last updated. Use the ISO 8601 Format.
+    TimeEntry = Struct.new(
+      'TimeEntry',
+      :id,
+      :spent_date,
+      :user,
+      :user_assignment,
+      :client,
+      :project,
+      :task,
+      :task_assignment,
+      :external_reference,
+      :invoice,
+      :hours,
+      :rounded_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,
+      keyword_init: true
+    )
+
+    TimeEntryExternalReference = Struct.new(
+      'TimeEntryExternalReference',
+      :id,
+      :group_id,
+      :permalink,
+      :service,
+      :service_icon_url,
+      keyword_init: true
+    )
+  end
+end

data/lib/harvest/resources/user.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param id [Integer]
+    #   Unique ID for the user.
+    # @param first_name [String]
+    #   The first name of the user.
+    # @param last_name [String]
+    #   The last name of the user.
+    # @param email [String]
+    #   The email address of the user.
+    # @param timezone [String]
+    #   The users timezone.
+    # @param has_access_to_all_future_projects [Boolean]
+    #   Whether the user should be automatically added to future projects.
+    # @param is_contractor [Boolean]
+    #   Whether the user is a contractor or an employee.
+    # @param is_admin [Boolean]
+    #   Whether the user has Admin permissions.
+    # @param is_project_manager [Boolean]
+    #   Whether the user has Project Manager permissions.
+    # @param can_see_rates [Boolean]
+    #   Whether the user can see billable rates on projects. Only applicable to Project Managers.
+    # @param can_create_projects [Boolean]
+    #   Whether the user can create projects. Only applicable to Project Managers.
+    # @param can_create_invoices [Boolean]
+    #   Whether the user can create invoices. Only applicable to Project Managers.
+    # @param is_active [Boolean]
+    #   Whether the user is active or archived.
+    # @param weekly_capacity [Integer]
+    #   The number of hours per week this person is available to work in seconds,
+    #   in half hour increments. For example, if a persons capacity is 35 hours,i
+    #   the API will return 126000 seconds.
+    # @param default_hourly_rate [decimal]
+    #   The billable rate to use for this user when they are added to a project.
+    # @param cost_rate [decimal]
+    #   The cost rate to use for this user when calculating a projects costs vs billable amount.
+    # @param roles [List]
+    #   of Strings    The role names assigned to this person.
+    # @param avatar_url [String]
+    #   The URL to the users avatar image.
+    # @param created_at [DateTime]
+    #   Date and time the user was created.
+    # @param updated_at [DateTime]
+    #   Date and time the user was last updated.
+    # @param name [String] combined first name and last name, only used in TimeEntry
+    User = Struct.new(
+      'User',
+      :id,
+      :first_name,
+      :last_name,
+      :email,
+      :telephone,
+      :timezone,
+      :weekly_capacity,
+      :has_access_to_all_future_projects,
+      :is_contractor,
+      :is_admin,
+      :is_project_manager,
+      :can_see_rates,
+      :can_create_projects,
+      :can_create_invoices,
+      :is_active,
+      :calendar_integration_enabled,
+      :calendar_integration_source,
+      :created_at,
+      :updated_at,
+      :roles,
+      :avatar_url,
+      :name,
+      keyword_init: true
+    )
+  end
+end

data/lib/harvest/resources/user_assignment.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param id [Integer]
+    #   Unique ID for the user assignment.
+    # @param project [Struct]
+    #   An object containing the id, name, and code of the associated project.
+    # @param user [Struct]
+    #   An object containing the id and name of the associated user.
+    # @param is_active [Boolean]
+    #   Whether the user assignment is active or archived.
+    # @param is_project_manager [Boolean]
+    #   Determines if the user has Project Manager permissions for the project.
+    # @param use_default_rates [Boolean]
+    #   Determines which billable rates will be used on the project for this user
+    #   when bill_by is People. When true, the project will use the users
+    #   default billable rates. When false, the project will use the custom rate
+    #   defined on this user assignment.
+    # @param hourly_rate [decimal]
+    #   Custom rate used when the projects bill_by is People and use_default_rates is false.
+    # @param budget [decimal]
+    #   Budget used when the projects budget_by is person.
+    # @param created_at [DateTime]
+    #   Date and time the user assignment was created.
+    # @param updated_at [DateTime]
+    #   Date and time the user assignment was last updated.
+    UserAssignment = Struct.new(
+      'UserAssignment',
+      :id,
+      :project,
+      :user,
+      :is_active,
+      :is_project_manager,
+      :use_default_rates,
+      :hourly_rate,
+      :budget,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+  end
+end

data/lib/harvest/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Harvest
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: harvest-ruby-v2
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Craig Davis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-06 00:00:00.000000000 Z
+dependencies: []
+description: Harvest API for v2  written in Fluent API style
+email:
+- craig.davis@rackspace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.rst
+- CODE_OF_CONDUCT.md
+- EXAMPLE.conf
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- harvest-ruby-v2.gemspec
+- lib/harvest.rb
+- lib/harvest/client.rb
+- lib/harvest/config.rb
+- lib/harvest/creates.rb
+- lib/harvest/discovers.rb
+- lib/harvest/exceptions.rb
+- lib/harvest/finders.rb
+- lib/harvest/http/client.rb
+- lib/harvest/httpclient.rb
+- lib/harvest/resourcefactory.rb
+- lib/harvest/resources.rb
+- lib/harvest/resources/client.rb
+- lib/harvest/resources/company.rb
+- lib/harvest/resources/estimates.rb
+- lib/harvest/resources/expenses.rb
+- lib/harvest/resources/invoices.rb
+- lib/harvest/resources/message.rb
+- lib/harvest/resources/project.rb
+- lib/harvest/resources/project_assignment.rb
+- lib/harvest/resources/task.rb
+- lib/harvest/resources/task_assignment.rb
+- lib/harvest/resources/timeentry.rb
+- lib/harvest/resources/user.rb
+- lib/harvest/resources/user_assignment.rb
+- lib/harvest/version.rb
+homepage: https://github.com/blade2005/harvest-ruby/wiki
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/blade2005/harvest-ruby/wiki
+  source_code_uri: https://github.com/blade2005/harvest-ruby
+  changelog_uri: https://github.com/blade2005/harvest-ruby/blob/master/CHANGELOG.rst
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Fluent API Harvest Client API v2
+test_files: []