saasu2 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1affbc76306877b1478cd092e7f30cee9dc54eb4
-  data.tar.gz: 97086f72357ed3b063a6667f8c3a6d47d9923044
+  metadata.gz: 1a8d35ea5e24cb6fe01ec9f88b9b46fb34a373d3
+  data.tar.gz: 3d71d23be75c004dee22405fd70ee1f1a9b54624
 SHA512:
-  metadata.gz: c6c4168807cc9dd04660890381a0aacb6259884f43ee21a0f7ef973893323310644101564e4dec06d29c05e58d6cdca67441ddc5546c514741aff6d387f523c4
-  data.tar.gz: 39d4bc50bed5d3088fa930c84669ac354f8cdeda4de2a2d2f9b514ee3cd2381f3379fe54ae56c3ca29dc36e6e203c2d293b456b7a6c0a7e6954dc961575529b7
+  metadata.gz: 9ac5b6e2b2c049042a34eef4d7d670ddd1d038bc77ab8dabdf9b5be3599766bccab348f51b39581c695d53c75a75f79088ffd8d6642a2187bc411ef1f2b7bd57
+  data.tar.gz: 35981f4eb95688dd6d94d65477e142312baab4d51245d44f061794a022d8e105f9c9e5c8249111a2b189d9d2faac0629a7c85ce4d4628ff940757a5d02865686

data/CHANGELOG.rdoc

@@ -1,4 +1,12 @@
+==== Version 0.1.4
+Features:
+* Saasu::User.reset_password – Allows a user to request that a password reset email be generated and sent to them.
+* Sassu::FileIdentity - list the set of files a user has access to.
+* Saasu::ContactAggregate - allows a user to add a Contact with a related company and contact manager in one call. This can also be retrieved and updated BUT NO delete operation is allowed.
+* Saasu::Search - new filtering options for transaction_type.
+* Saasu::Invoice#email - allows emailing to the contact on the invoice or emailing to a specified email address.
+
 ==== Version 0.1.2
 Features:
 * Add support #create, #update, #destroy methods for /Items API
-* Add support for /Search endpoint
+* Add support for /Search endpoint

data/README.md

@@ -42,6 +42,9 @@ You can access the following objects:
 - Saasu::Payment
 - Saasu::TaxCode
 - Saasu::Search
+- Saasu::User
+- Saasu::FileIdentity
+- Saasu::ContactAggregate
 
 Usage examples:
 
@@ -76,13 +79,25 @@ contact['GivenName'] = 'John'
 # get all attributes
 contact.attributes
 
-# Search. Available scopes: All, Transactions, Contacts, InventoryItems.
+# Search. Available scopes: All, Transactions, Contacts, InventoryItems. 
 query = Saasu::Search.new('Book', 'InventoryItems')
 query.perform
 
 query.contacts
 query.items
 query.invoices
+
+# You can filter search results by transaction type - Sale, Purchase, Journal, Payroll
+query = Saasu::Search.new('Book', scope: 'InventoryItems', transaction_type: 'Sale')
+
+# or you can use the default scope - 'All'
+query = Saasu::Search.new('Book', transaction_type: 'Purchase')
+
+# reset user password
+Saasu::User.reset_password('user@saasu.com')
+
+# list the set of files a user has access to
+Saasu::FileIdentity.all
 ```
 
 Note - Saasu uses .NET naming convention for fields and filters eg. GivenName, LastModifiedDate

data/lib/saasu/contact_aggregate.rb

@@ -0,0 +1,3 @@
+class Saasu::ContactAggregate < Saasu::Base
+  allowed_methods :show, :update, :create
+end

data/lib/saasu/file_identity.rb

@@ -0,0 +1,7 @@
+class Saasu::FileIdentity < Saasu::Base
+  allowed_methods :show, :index
+
+  def self.find(file_id)
+    Saasu::Client.request(:get, 'FileIdentity', { FileId: file_id })
+  end
+end

data/lib/saasu/invoice.rb

@@ -1,4 +1,16 @@
 class Saasu::Invoice < Saasu::Base
   allowed_methods :show, :index, :destroy, :update, :create
   filter_by %W(InvoiceNumber LastModifiedFromDate LastModifiedToDate TransactionType Tags TagSelection InvoiceFromDate InvoiceToDate InvoiceStatus PaymentStatus ContactId)
+
+  def email(email_address = nil)
+    if email_address.present?
+      url = ['Invoice', id, 'email'].join('/')
+      params = { EmailTo: email_address }
+    else
+      url = ['Invoice', id, 'email-contact'].join('/')
+      params = {}
+    end
+
+    Saasu::Client.request(:post, url, params)
+  end
 end

data/lib/saasu/search.rb

@@ -3,8 +3,17 @@ module Saasu
     VALID_SCOPES = %W(All Transactions Contacts InventoryItems)
     attr_accessor :scope, :keywords
 
-    def initialize(keywords, scope = 'All')
-      @scope = scope
+    # allowed params:
+    # :scope - All, Transactions, Contacts, InventoryItems
+    # :transaction_type - Sale, Purchase, Journal, Payroll
+    def initialize(keywords, params = {})
+      if params.is_a?(Hash)
+        @scope = params[:scope].presence || 'All'
+        @transaction_type = "Transactions.#{params[:transaction_type]}" if params[:transaction_type].present?
+      else
+        @scope = params
+      end
+
       @keywords = keywords
 
       validate_scope!
@@ -34,8 +43,14 @@ module Saasu
     end
 
     private
+    def search_params
+      _params = { Scope: @scope, Keywords: @keywords, IncludeSearchTermHighlights: false }
+      _params[:TransactionType] = @transaction_type if @transaction_type.present?
+      _params
+    end
+
     def perform_search!
-      @search_results = Saasu::Client.request(:get, 'search', { Scope: @scope, Keywords: @keywords, IncludeSearchTermHighlights: false })
+      @search_results = Saasu::Client.request(:get, 'search', search_params)
     end
 
     def search_results

data/lib/saasu/user.rb

@@ -0,0 +1,6 @@
+class Saasu::User < Saasu::Base
+  def self.reset_password(username)
+    raise "Username is required." if username.blank?
+    Saasu::Client.request(:post, 'User/reset-password', { Username: username })['StatusMessage']
+  end
+end

data/lib/saasu/version.rb

@@ -1,3 +1,3 @@
 module Saasu
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/saasu.rb

@@ -12,6 +12,9 @@ require "saasu/tax_code"
 require "saasu/config"
 require "saasu/auth"
 require "saasu/search"
+require "saasu/user"
+require "saasu/file_identity"
+require "saasu/contact_aggregate"
 
 module Saasu
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saasu2
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Nick Sinenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-20 00:00:00.000000000 Z
+date: 2015-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,12 +177,15 @@ files:
 - lib/saasu/company.rb
 - lib/saasu/config.rb
 - lib/saasu/contact.rb
+- lib/saasu/contact_aggregate.rb
+- lib/saasu/file_identity.rb
 - lib/saasu/invoice.rb
 - lib/saasu/invoice_attachment.rb
 - lib/saasu/item.rb
 - lib/saasu/payment.rb
 - lib/saasu/search.rb
 - lib/saasu/tax_code.rb
+- lib/saasu/user.rb
 - lib/saasu/version.rb
 - saasu2.gemspec
 homepage: https://api.saasu.com
@@ -205,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Saasu API.