saasu2 0.1.0.pre → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef4f91281902664f17b2c52ee2871df934c51d42
-  data.tar.gz: 43f634972cb7b6b9645d908e2961bf6c311c4f27
+  metadata.gz: 00d34d8d6d01b5a1ba07efb6a978829a6ca8e78f
+  data.tar.gz: 8864f8c57abb79e676cfc465e85f571e17f15c9c
 SHA512:
-  metadata.gz: 25149c64b15e36ca720edd0fb41f238fcdad0d97eb8ec6760b59016ab952a72c2398f30c472fff8e21a97ec7860f7f1b5f2d1a0de66d8d1cccf86e099db2af62
-  data.tar.gz: 9c6bda2d041394d1a57e92407ae9f3f20e8558d8c89e42296cd77fc43e49e75a2f6d55ccaa7910fea15c77c3b00267464a94e0e0463ed7690f6937de4670eda9
+  metadata.gz: e9289d659a6c7f098d3b1a85c3f81483b2fa699af3adce974b377d8ee899f94fa6ff850107aaffb7a82178fb2cf0c86474204e751c4f0e41f8f5b9a3cd2648e8
+  data.tar.gz: 87af3716b0aabaa9db71677d66322bf6100f293c7507fdc7e7e010e8986bba9fe25b244442741dd546f27a9d4a3b2c5c945532f911127cfe96030f00280c0cc3

data/README.md

@@ -17,13 +17,70 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Create an initializer file with your Saasu configuration eg config/initilizers/saasu.rb
+```ruby
+require 'saasu'
+
+Saasu::Config.configure do |c|
+  c.username = 'username@email.com'
+  c.password = 'password'
+  c.file_id = 1234 # Your Saasu FileId can be found at
+end
+```
+
+You're now ready to connect your app to Saasu.
+
+## Usage
+
+You can access the following objects:
+- Saasu::Account
+- Saasu::Company
+- Saasu::Contact
+- Saasu::Invoice
+- Saasu::InvoiceAttachment
+- Saasu::Item
+- Saasu::Payment
+- Saasu::TaxCode
+
+Usage examples:
+
+```ruby
+# get all contacts
+contacts = Saasu::Contact.all
+
+# find a contact by id
+contact = Saasu::Contact.find(123)
+
+# save a contact
+contact.given_name = 'New Name'
+contact.save
+
+# delete a contact
+contact.delete
+
+# create a contact
+new_contact = Saasu::Contact.create({ GivenName => 'User' })
+
+# filter records. for a list of available filters for each object see https://api.saasu.com
+contact = Saasu::Contact.where(GivenName: 'John')
+
+# get attributes
+contact.id
+contact['Id']
+
+# set attributes
+contact.given_name = 'Nick'
+contact['GivenName'] = 'John'
+
+# get all attributes
+contact.attributes
+```
 
-    $ gem install saasu2
+Note - Saasu uses .NET naming convention for fields and filters eg. GivenName, LastModifiedDate
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/saasu2/fork )
+1. Fork it ( https://github.com/saasu/saasu2-ruby/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/saasu/base.rb

@@ -1,5 +1,7 @@
 module Saasu
   class Base
+    attr_reader :attributes
+
     def initialize(params = {})
       @attributes = params.deep_stringify_keys
     end

data/lib/saasu/version.rb

@@ -1,3 +1,3 @@
 module Saasu
-  VERSION = "0.1.0.pre"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saasu2
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.1
 platform: ruby
 authors:
 - Nick Sinenko
@@ -198,9 +198,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2