softlayer 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c19f44cbeeb5b86cbc8d04c6fd980cd6699d1f9
-  data.tar.gz: 727f1a5cb636c9eb5df3ce71319b305df1490e0a
+  metadata.gz: 3a852ac905950499ded0c1ee0b252675117d037c
+  data.tar.gz: 564f43344c81ac8ff120dd4253ebd5714dca68b0
 SHA512:
-  metadata.gz: e0da27455c1c3abf6dca3a973904e1f1683c1efe6c148b2772856d9c136ea434afb7d6363e5d684225f615b78d676710afa876e2eb6df189fd47b41cda52dc4d
-  data.tar.gz: 177efb83838ce36bab4c24e93547bcfadc65b16af9c91272a323b24e62bca86da1cead87c3cb1290bb2e2cfe83b79e8630185b465e126d572cdd2de6b5665fa5
+  metadata.gz: e87fe136b2d4e82068c37d58b13403b91289b67760b160c3f08613c638d4faacd3a53d011ad139b8de323df7cf032250ec3dbe62d197582a1aebebb6d3d98779
+  data.tar.gz: 017e5036081f15a89e092dab2006970b0c70eecb3410f29be22bfb98689e030a0eb3f4a9c2375d2894046308bc44697ca600e2bbbe7ad60f06c199468742346d

data/README.md

@@ -39,13 +39,98 @@ Softlayer::Account.get_master_user
 Softlayer::Account.get_virtual_guests
 ```
 
+### Masks
+
+If you'd like to get relational properties, you can use masks to get more information in a single request, lets consider the example below
+
+Consider an example where we want to get datacenters, but not only their `id`, `longName`, `name` and `statusId` (default returned information), we want to get their groups too, instead of make one request per datacenter, we can get all the information with just one request
+
+```ruby
+location_object_mask = "mask[groups]"
+Softlayer::Location::Datacenter.mask(location_object_mask).get_datacenters
+```
+
+And _voilá_, we have all datacenters and its groups, pretty neat and cool, no?
+
+Check the [Object Mask Article](https://sldn.softlayer.com/article/object-masks) on SoftLayer for more information.
+
+### Filters
+
+Lets consider an example where we want to find a datacenter based on its name, we can create a filter and do the request as following:
+
+```ruby
+location_object_filter = {
+  'name': {'operation': 'wdc01'}
+}
+Softlayer::Location::Datacenter.filter(location_object_filter)
+```
+
+For an `in` operation you must add the array inside an array because the client known issue, let's search for wdc01 and wdc04
+
+```ruby
+location_object_filter = {
+    'name': {
+      'operation': "in",
+      "options": [[
+        {
+          "name": "data",
+          "value": [['wdc01', 'wdc04']]
+        }
+      ]]
+    }
+}
+Softlayer::Location::Datacenter.filter(location_object_filter).get_datacenters
+```
+
+Check the [Object Filter Article](https://sldn.softlayer.com/article/object-filters) on SoftLayer for more information and operations.
+
+### Limits
+
+To use limits, let's search for groups of a datacenter, first we get a specific one
+
+```ruby
+location_object_filter = {
+    'name': {'operation': 'sao01'}
+}
+sao01 = Softlayer::Location::Datacenter.filter(location_object_filter).get_datacenters.first
+```
+
+Then we can call the limits passing first the quantity, then the offset
+
+```ruby
+sao01.limit(2, 0).get_groups # 2 elements, offset 0 (page 1)
+sao01.limit(2, 2).get_groups # 2 elements, offset 2 (page 2)
+sao01.limit(2, 4).get_groups # 2 elements, offset 4 (page 3)
+```
+
+### Complex Operations
+
+What if you want to use a mask, filtering just what you want and limiting the request, can we do this? Sure!
+
+```ruby
+location_object_filter = {
+    'name': {
+      'operation': "in",
+      "options": [[
+        {
+          "name": "data",
+          "value": [['wdc01', 'wdc04']]
+        }
+      ]]
+    }
+}
+location_object_mask = "mask[groups]"
+Softlayer::Location::Datacenter.filter(location_object_filter).mask(location_object_mask).limit(1, 0).get_datacenters
+```
+
+ps: `getDatacenters` message does not accept a `resultLimit` header, just using on the call above as an example, to check if the message accepts a `resultLimit` or not you need to check the WSDL file for the service.
+
 ## README Driven Development
 
-* Improve support for masks and filters (parse a better format instead of using ruby hash)
+* No feature on roadmap
 
 ## Known Issues
 
-* Mask and Filter not working correctly with `SoftLayer_Account` calls
 * Using Savon master until a version is released containing the commit to support rpc/encoded XML
 * Actually arrays are being wrongly mapped, so when we pass an argument containing **one** array, we need to pass inside another array, like this:
 
@@ -61,7 +146,7 @@ parameters = {
 }
 ```
 
-hope to fix this _really soon_
+hope to fix this _really soon_, in the meanwhile you can check the progress of this bug on this [issue](https://github.com/savonrb/savon/issues/752)
 
 ## Development
 

data/lib/softlayer/model.rb

@@ -129,6 +129,10 @@ module Softlayer #:nodoc:
       (self.class.to_s+"::Representer").constantize.new(self).to_hash
     end
 
+    def service_name
+      self.class.service_name
+    end
+
     def init_headers
       raise Exception.new('You need to set the ID on object') if id.nil?
       {

data/lib/softlayer/version.rb

@@ -1,3 +1,3 @@
 module Softlayer
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: softlayer
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Celso Fernandes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon