printnode 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4ba5de2c1f7ad599ae097006cb43a39f93bd5c5
-  data.tar.gz: 7f8decb443228851248cdd22e304144341c00ef9
+  metadata.gz: 42809a5cd95dc96bd18b91b67811650e0c260309
+  data.tar.gz: 849046e8086d36e97531332a14668bb49d664379
 SHA512:
-  metadata.gz: 028e786c6a0bd47c1fa892ce288283b22d2832ec8d907ff4a58e427a0cf03fd82061d5f01b24a3cac3aac82e42e1168346f2f7535c2244ec9617bdaf63a9f74d
-  data.tar.gz: b02819ee3ee78c53912ad1bc80482cfa051b5574286e862021760bb5a8fe4735c5264e67bb945f539876c924da905636aeedb76bd45e56e2edbc67bd1496579f
+  metadata.gz: 11d4c32803161dccd13398dd0dd694fc0ee403c9703a191de5b43d2808aec5a967c1d257dbc8dd0287e5c3a910fc17379707da6bc8847a2d54c911b85d08997b
+  data.tar.gz: 0ee1532855057fe51c86db5d3f0678178cca29ef16123b56a044242b0c278c3e5320cd952c766f57c2557da93d5e30938a4da21e9eafa7ff906b7f44a260df46

data/lib/printnode/account.rb

@@ -1,4 +1,7 @@
 module PrintNode
+  # An object to deal with Account Creation.
+  # @author Jake Torrance
+  # @author PrintNode
   class Account
     attr_accessor :firstname
     attr_accessor :lastname
@@ -6,6 +9,7 @@ module PrintNode
     attr_accessor :password
     attr_accessor :creator_ref
 
+    # Map our object into a hash for JSON Encoding.
     def to_hash
       hash = {}
       hash['firstname'] = @firstname
@@ -16,6 +20,7 @@ module PrintNode
       hash
     end
 
+    # Initialize our object ready for being mapped into a hash.
     def initialize(firstname, lastname, email, password)
       @firstname = firstname
       @lastname = lastname

data/lib/printnode/client.rb

@@ -10,6 +10,14 @@ module PrintNode
   # @author Jake Torrance
   # @author PrintNode
   class Client
+
+    # If an argument is not a string, map it to a string so it can be escaped
+    # and put into a URL.
+    #
+    # @param obj Object to be mapped into a string and escaped.
+    #
+    # == Returns:
+    # CGI.escaped object.
     def escape_with_types(obj)
       obj = obj.to_s unless obj.is_a?(String)
       CGI.escape(obj)
@@ -356,6 +364,13 @@ module PrintNode
       parse_array_to_struct(response_object)
     end
 
+    # Sends a GET request to /computer/(computer_id)/scales
+    #
+    # @param computer_id [String] a set of computers to be got.
+    #
+    # == Returns:
+    # An Array of OpenStruct objects. The design of this Object will be the same as the ones on the PrintNode API docs.
+    # @see https://www.printnode.com/docs/api/curl/#scales Scales on API Docs
     def scales(computer_id)
       end_point_url = '/computer/' +
                       escape_with_types(computer_id) +
@@ -363,6 +378,7 @@ module PrintNode
       response_object = JSON.parse(get(end_point_url).body)
       parse_array_to_struct(response_object)
     end
+
     # Sends a GET request to /printers/(set_a), or:
     # /computers/(set_a)/printers/(set_b) if set_b is used.
     #

data/lib/printnode/printjob.rb

@@ -1,5 +1,8 @@
 require 'base64'
 module PrintNode
+  # An object for printjob creation.
+  # @author Jake Torrance
+  # @author PrintNode
   class PrintJob
     attr_accessor :printer_id
     attr_accessor :title
@@ -7,6 +10,7 @@ module PrintNode
     attr_accessor :content
     attr_accessor :source
 
+    # Maps the object into a hash ready for JSON Encoding.
     def to_hash
       hash = {}
       hash['printerId'] = @printer_id
@@ -21,6 +25,7 @@ module PrintNode
       hash
     end
 
+    # Initializes the object with the variables required.
     def initialize(printer_id, title, content_type, content, source)
       @printer_id = printer_id
       @title = title

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: printnode
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - PrintNode
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2015-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json