harvested 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9671d7604da7b9da9bee9fd922b00cac9aa08a9
-  data.tar.gz: e0295ab8a592616dff967a03a43ec9b0c669d3b9
+  metadata.gz: b320e8b059c090f49100d56dd033bd1cd8d388ea
+  data.tar.gz: 4edae05dec9b1f29e4e73315d071f104849b0911
 SHA512:
-  metadata.gz: 5fac81456746627a0ff7372defcf6013ada70ae07e53013085c7844761b1a853c9f1f666af0d0fcdd3a83969a3b7d78c01b6b1ca499980e089301d2d5c56c154
-  data.tar.gz: d54e0f9f6b67aa16747cf2f527d954a5bdc42501819727396b43a2abb0a4d53423940d85e0ea5b5378b2c501e02e800e4a895090c8890460c2bcce3b0c75f581
+  metadata.gz: 237ff0b0bd1c19bbd60620b9c4df92c2de856e3557c70e0a777a482f03bf5b5dfb9730668a88614664dfcebd5eef1ceb0363ca65397fa061c3c4f6d384ece125
+  data.tar.gz: 7956415b92ee623735f3eef012a74f0bc9ba039eee99eb66fdaf54a875356c5f28e2aac660b28bf300d2c7e5446a9e8c0ae709dc40bfed67e12438ed3c9664db

data/HISTORY.md

@@ -1,10 +1,15 @@
+## 3.1.0 - Aug 29, 2014
+  * Allows Invoice Messages to be created (Thanks Thomas Balthazar - @tbalthazar)
+
+## 3.0.0 - Aug 29, 2014
+  * No longer requires Hashie v1 as a dependency
+  * Fixes bug where project hints were not handled properly
+
 ## 3.0.0.rc1 - May 30, 2014
   * Require Ruby 2.0+
   * Allow OAuth authentication (Thanks Brendan Loudermilk - @bloudermilk)
   * Allow expenses_by_project to be retrieved (Thanks Jordan Yeo - @jordanyeo)
   * Reports now pass through any remaining options (Thanks Philip Arndt - @parndt)
-  * No longer requires Hashie v1 as a dependency
-  * Fixes bug where project hints were not handled properly
 
 ## 2.0.0 - April 23, 2014
   * Every connection must be SSL

data/lib/harvest/api/invoice_messages.rb

@@ -0,0 +1,75 @@
+module Harvest
+  module API
+    class InvoiceMessages < Base
+      api_model Harvest::InvoiceMessage
+      include Harvest::Behavior::Crud
+
+      def all(invoice)
+        response = request(:get, credentials, "/invoices/#{invoice.to_i}/messages")
+        api_model.parse(response.parsed_response)
+      end
+
+      def find(invoice, message)
+        response = request(:get, credentials, "/invoices/#{invoice.to_i}/messages/#{message.to_i}")
+        api_model.parse(response.parsed_response).first
+      end
+
+      def create(message)
+        message = api_model.wrap(message)
+        response = request(:post, credentials, "/invoices/#{message.invoice_id}/messages", :body => message.to_json)
+        id = response.headers["location"].match(/\/.*\/(\d+)\/.*\/(\d+)/)[2]
+        find(message.invoice_id, id)
+      end
+
+      def delete(message)
+        request(:delete, credentials, "/invoices/#{message.invoice_id}/messages/#{message.to_i}")
+        message.id
+      end
+
+      # Create a message for marking an invoice as sent.
+      #
+      # @param [Harvest::InvoiceMessage] The message you want to send
+      # @return [Harvest::InvoiceMessage] The sent message
+      def mark_as_sent(message)
+        send_status_message(message, 'mark_as_sent')
+      end
+
+      # Create a message and mark an open invoice as closed (writing an invoice off)
+      #
+      # @param [Harvest::InvoiceMessage] The message you want to send
+      # @return [Harvest::InvoiceMessage] The sent message
+      def mark_as_closed(message)
+        send_status_message(message, 'mark_as_closed')
+      end
+
+      # Create a message and mark a closed (written-off) invoice as open
+      #
+      # @param [Harvest::InvoiceMessage] The message you want to send
+      # @return [Harvest::InvoiceMessage] The sent message
+      def re_open(message)
+        send_status_message(message, 're_open')
+      end
+
+      # Create a message for marking an open invoice as draft
+      #
+      # @param [Harvest::InvoiceMessage] The message you want to send
+      # @return [Harvest::InvoiceMessage] The sent message
+      def mark_as_draft(message)
+        send_status_message(message, 'mark_as_draft')
+      end
+
+      private
+
+      def send_status_message(message, action)
+        message = api_model.wrap(message)
+        response = request( :post, 
+                            credentials, 
+                            "/invoices/#{message.invoice_id}/messages/#{action}",
+                            :body => message.to_json
+                          )
+        message
+      end
+
+    end
+  end
+end

data/lib/harvest/base.rb

@@ -288,5 +288,40 @@ module Harvest
     def invoice_payments
       @invoice_payments ||= Harvest::API::InvoicePayments.new(credentials)
     end
+
+    # All API Actions surrounding invoice messages
+    #
+    # == Examples
+    #
+    #  invoice = harvest.invoices.find(100)
+    #  harvest.invoice_messages.all(invoice) # returns all messages for the invoice (as Harvest::InvoicePayment)
+    #
+    #  invoice = harvest.invoices.find(100)
+    #  harvest.invoice_messages.find(invoice, 5) # returns the message with ID 5, assigned to the invoice
+    #
+    #  invoice = harvest.invoices.find(100)
+    #  message = Harvest::InvoiceMessage.new(:invoice_id => invoice.id)
+    #  saved_message = harvest.invoice_messages.create(message) # returns a saved version of the message
+    #
+    #  invoice = harvest.invoices.find(100)
+    #  message = harvest.invoice_messages.find(invoice, 5)
+    #  harvest.invoice_messages.delete(message) # returns 5
+    #
+    #  invoice = harvest.invoices.find(100)
+    #  message = Harvest::InvoiceMessage.new(:invoice_id => invoice.id)
+    #  harvest.invoice_messages.mark_as_sent(message)
+    #  
+    #  invoice = harvest.invoices.find(100)
+    #  message = Harvest::InvoiceMessage.new(:invoice_id => invoice.id)
+    #  harvest.invoice_messages.mark_as_closed(message)
+    #
+    #  invoice = harvest.invoices.find(100)
+    #  message = Harvest::InvoiceMessage.new(:invoice_id => invoice.id)
+    #  harvest.invoice_messages.re_open(message)
+    #
+    # @return [Harvest::API::InvoiceMessages]
+    def invoice_messages
+      @invoice_messages ||= Harvest::API::InvoiceMessages.new(credentials)
+    end
   end
 end

data/lib/harvest/invoice_message.rb

@@ -0,0 +1,8 @@
+module Harvest
+  class InvoiceMessage < Hashie::Mash
+    include Harvest::Model
+
+    api_path '/messages'
+    def self.json_root; 'message'; end
+  end
+end

data/lib/harvest/version.rb

@@ -1,3 +1,3 @@
 module Harvest
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/lib/harvested.rb

@@ -20,8 +20,8 @@ require 'harvest/timezones'
 require 'harvest/base'
 
 %w(crud activatable).each {|a| require "harvest/behavior/#{a}"}
-%w(model client contact project task user rate_limit_status task_assignment user_assignment expense_category expense time_entry invoice_category line_item invoice invoice_payment trackable_project).each {|a| require "harvest/#{a}"}
-%w(base account clients contacts projects tasks users task_assignments user_assignments expense_categories expenses time reports invoice_categories invoices invoice_payments).each {|a| require "harvest/api/#{a}"}
+%w(model client contact project task user rate_limit_status task_assignment user_assignment expense_category expense time_entry invoice_category line_item invoice invoice_payment invoice_message trackable_project).each {|a| require "harvest/#{a}"}
+%w(base account clients contacts projects tasks users task_assignments user_assignments expense_categories expenses time reports invoice_categories invoices invoice_payments invoice_messages).each {|a| require "harvest/api/#{a}"}
 
 module Harvest
   class << self

data/spec/factories.rb

@@ -51,6 +51,14 @@ FactoryGirl.define do
     notes "Payment received"
   end
 
+  factory :invoice_message, class: Harvest::InvoiceMessage do
+    body "The message body goes here"
+    recipients "john@example.com, jane@example.com"
+    attach_pdf true
+    send_me_a_copy true
+    include_pay_pal_link true
+  end
+
   factory :project, class: Harvest::Project do
     name { generate(:project_name) }
   end

data/spec/functional/invoice_messages_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe 'harvest invoice messages' do
+  it 'allows adding/removing messages to invoice and retrieving existing invoice messages' do
+    # Make sure Reminder Message is turned off for this test to pass
+
+    cassette('invoice_message1') do
+      # create a new client and invoice
+      client = harvest.clients.create(FactoryGirl.attributes_for(:client))
+      invoice = harvest.invoices.create(FactoryGirl.attributes_for(:invoice, :client_id => client.id, :issued_at => Date.today - 2, :due_at_human_format => 'NET 30'))
+
+      # add a message to the invoice
+      message = Harvest::InvoiceMessage.new(FactoryGirl.attributes_for(:invoice_message,
+                                                                       :invoice_id => invoice.id,
+                                                                       :body => "A message body"))
+      message_saved = harvest.invoice_messages.create(message)
+
+      # retrieve the created invoice and compare
+      message_found = harvest.invoice_messages.find(invoice, message_saved)
+      message_found.should == message_saved
+
+      # add another message to the invoice
+      message2 = Harvest::InvoiceMessage.new(FactoryGirl.attributes_for(:invoice_message,
+                                                                        :invoice_id => invoice.id,
+                                                                        :body => "Another message body"))
+      message2_saved = harvest.invoice_messages.create(message2)
+
+      # get all the messages and test if our 2 saved messages are included
+      messages = harvest.invoice_messages.all(invoice)
+      messages.should include(message_saved)
+      messages.should include(message2_saved)
+
+      # remove a message
+      harvest.invoice_messages.delete(message_saved)
+      messages = harvest.invoice_messages.all(invoice)
+      messages.should_not include(message_saved)
+      messages.should include(message2_saved)
+
+      # remove another message
+      harvest.invoice_messages.delete(message2_saved)
+      messages = harvest.invoice_messages.all(invoice)
+      messages.should_not include(message_saved)
+      messages.should_not include(message2_saved)
+
+      harvest.invoice_messages.all(invoice).should be_empty
+    end
+  end
+
+  it 'allows to change the state of an invoice' do
+    cassette('invoice_message2') do
+      # create a new client and invoice
+      client = harvest.clients.create(FactoryGirl.attributes_for(:client))
+      invoice = harvest.invoices.create(FactoryGirl.attributes_for(:invoice, :client_id => client.id))
+
+      # check the invoice state is 'draft'
+      invoice = harvest.invoices.find(invoice.id)
+      invoice.state.should == 'draft'
+
+      # -- mark as sent
+      message = Harvest::InvoiceMessage.new(FactoryGirl.attributes_for(:invoice_message,
+                                                                       :invoice_id => invoice.id,
+                                                                       :body => "sent body message"))
+      harvest.invoice_messages.mark_as_sent(message)
+
+      # check the invoice state and latest message body
+      invoice = harvest.invoices.find(invoice.id)
+      invoice.state.should == 'open'
+      messages = harvest.invoice_messages.all(invoice)
+      messages.last.body.should == message.body
+
+      # -- mark_as_closed (write off)
+      message.body = "close body message"
+      harvest.invoice_messages.mark_as_closed(message)
+
+      # check the invoice state and latest message body
+      invoice = harvest.invoices.find(invoice.id)
+      invoice.state.should == 'closed'
+
+      # -- re_open
+      message.body = "re-open body message"
+      harvest.invoice_messages.re_open(message)
+      messages = harvest.invoice_messages.all(invoice)
+
+      # check the invoice state and latest message body
+      invoice = harvest.invoices.find(invoice.id)
+      invoice.state.should == 'open'
+    end
+  end
+end

data/spec/harvest/invoice_message_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Harvest::InvoiceMessage do
+  it_behaves_like 'a json sanitizer', %w(cache_version)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harvested
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Zach Moazeni
@@ -87,6 +87,7 @@ files:
 - lib/harvest/api/expense_categories.rb
 - lib/harvest/api/expenses.rb
 - lib/harvest/api/invoice_categories.rb
+- lib/harvest/api/invoice_messages.rb
 - lib/harvest/api/invoice_payments.rb
 - lib/harvest/api/invoices.rb
 - lib/harvest/api/projects.rb
@@ -108,6 +109,7 @@ files:
 - lib/harvest/hardy_client.rb
 - lib/harvest/invoice.rb
 - lib/harvest/invoice_category.rb
+- lib/harvest/invoice_message.rb
 - lib/harvest/invoice_payment.rb
 - lib/harvest/line_item.rb
 - lib/harvest/model.rb
@@ -128,6 +130,7 @@ files:
 - spec/functional/errors_spec.rb
 - spec/functional/expenses_spec.rb
 - spec/functional/hardy_client_spec.rb
+- spec/functional/invoice_messages_spec.rb
 - spec/functional/invoice_payments_spec.rb
 - spec/functional/invoice_spec.rb
 - spec/functional/project_spec.rb
@@ -139,6 +142,7 @@ files:
 - spec/harvest/basic_auth_credentials_spec.rb
 - spec/harvest/expense_category_spec.rb
 - spec/harvest/expense_spec.rb
+- spec/harvest/invoice_message_spec.rb
 - spec/harvest/invoice_payment_spec.rb
 - spec/harvest/invoice_spec.rb
 - spec/harvest/oauth_credentials_spec.rb
@@ -184,6 +188,7 @@ test_files:
 - spec/functional/errors_spec.rb
 - spec/functional/expenses_spec.rb
 - spec/functional/hardy_client_spec.rb
+- spec/functional/invoice_messages_spec.rb
 - spec/functional/invoice_payments_spec.rb
 - spec/functional/invoice_spec.rb
 - spec/functional/project_spec.rb
@@ -195,6 +200,7 @@ test_files:
 - spec/harvest/basic_auth_credentials_spec.rb
 - spec/harvest/expense_category_spec.rb
 - spec/harvest/expense_spec.rb
+- spec/harvest/invoice_message_spec.rb
 - spec/harvest/invoice_payment_spec.rb
 - spec/harvest/invoice_spec.rb
 - spec/harvest/oauth_credentials_spec.rb