sugarcrb 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d289971f4ca6ac4721c7a68bfb9e13453311ffd9
-  data.tar.gz: 7470ff19764747c6470f7551fe7c0f33cce0ef43
+  metadata.gz: abef30c9fdda65054c091efa0145e080991d5241
+  data.tar.gz: 58b620f89c324e72d26b61bb54482cde2fb0e286
 SHA512:
-  metadata.gz: 3760035d1eb92e0664ad2b40604da11e78261cca2fbfb7b91c72bfe9b9af6ecf8269d4cde7fb8236e4700dd6bc109403884319d0ffb233d6bdd7b0f8769d76fd
-  data.tar.gz: 13d2baeed627f0d80ef29d7509ee7dd8773a3f3c7e6aab3a7f79728c5befbc8d277adab5ab9ca850031a066582847921100dbd5b13a0c75798af3e80b0241e79
+  metadata.gz: d93162c29bfb4acfe7a95d95a94d997238b6206f09702b7f03edf5fcc911ad0420607b68945e1bc6fef0e84403266d0780e91a1967552a0d1e6e86f3e195f85d
+  data.tar.gz: c45f76fa1ba8145366ed688ef278acefb71970cc050f40d1be5d6a96ebe5c682b6a78a7bda595c0ffc2a3600e799885d1799e2d52e7218f94abe9cec4e5977b9

data/README.md

@@ -22,7 +22,71 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Login
+
+```ruby
+sugarcrb = Sugarcrb.new(<host>,<username>,<password>,<platform>,<client id>,<client secret>)
+
+sugarcrb = Sugarcrb.new("https://instance.sugarondemand.com","admin","xxxxxx","test","sugar","")
+```
+
+Call endpoint
+
+```ruby
+response = sugarcrb.call "<method>", "<url endpoint>", <data>
+```
+
+Create a bean
+
+```ruby
+response = sugarcrb.call "post", "<module>", <data>
+response = sugarcrb.call "post", "Accounts", {
+    "name" => "My Account"
+}
+account_data = JSON.load(response)
+```
+
+List beans
+
+```ruby
+response = sugarcrb.call "get", "<module>"
+
+response = sugarcrb.call "get", "Accounts"
+accounts_data = JSON.load(response)
+accounts_data['records']
+```
+
+Get a bean
+
+```ruby
+response = sugarcrb.call "get", "<module>/<id>"
+
+response = sugarcrb.call "get", "Accounts/dffe626e-08d2-11e7-9113-06b20b8677ed"
+account_data = JSON.load(response)
+```
+
+Update a bean
+
+```ruby
+response = sugarcrb.call "put", "<module>/<id>", <data>
+
+response = sugarcrb.call "put", "Accounts/dffe626e-08d2-11e7-9113-06b20b8677ed", {
+    "name" => "My Favorite Account"
+}
+account_data = JSON.load(response)
+```
+
+Delete a bean
+
+```ruby
+response = sugarcrb.call "delete", "<module>/<id>"
+
+response = sugarcrb.call "delete", "Accounts/dffe626e-08d2-11e7-9113-06b20b8677ed"
+if response.code == 200 then
+    puts "deleted"
+end
+```
+
 
 ## Development
 

data/lib/sugarcrb/version.rb

@@ -1,3 +1,3 @@
 class Sugarcrb
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/sugarcrb.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["pedroalbertose007@gmail.com"]
 
   spec.summary       = "Sugarcrm client"
-  spec.description   = "Gem to use create a cliente to SugarCRM by API rest V10"
+  spec.description   = "Gem to create a client to Consume SugarCRM's API rest V10"
   spec.homepage      = "https://rubygems.org/gems/sugarcrb"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sugarcrb
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - betobaz
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description: Gem to use create a cliente to SugarCRM by API rest V10
+description: Gem to create a client to Consume SugarCRM's API rest V10
 email:
 - pedroalbertose007@gmail.com
 executables: []