finerworks 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77105142ccb403a4a0b6733f5ca9c5ae68654a05
-  data.tar.gz: 4b8928f2062635b29662ce43c0ddcbbba1336c67
+  metadata.gz: 9849afa0d50592f8063c79f1cecb2d7ada65886e
+  data.tar.gz: 5a9b49f431073e1a12104a133c7f5d3102e38559
 SHA512:
-  metadata.gz: c98c85c7c3c2dc80a101e5458038eac72db42e3ebb8240b17af7334ae1803b5144c856bd87b88a34c03cfd8e2a5c1d7e1dbbec39434f2d0840188447a65159c4
-  data.tar.gz: 523d013eb10b6ef4f3b22ff39173031cf8b562d8141dbd28dafa7aa1be0c0ea5457df33ea10c2341ad627f9bcc079c4f5a61f2528e8abe4063fc9a9c4e48db7c
+  metadata.gz: ab771f955b0f0958a2823dc8eeb6d58a2910504c5d51ac4aeae2cc184a2b6c3c8e0294e38112679595511f477dec103eb5355d91d43d6f54747efa2a789ec521
+  data.tar.gz: fd6cab6d6519b57863c229cdf1c7a40c9956520f3eca2ab9e7fa0830cfdce2bf380cd236f5aad4a7855c61b8048480ebcb8032fe32f00f3af88793871c85b1aa

data/lib/finerworks/client.rb

@@ -8,6 +8,9 @@ require 'finerworks/order'
 require 'finerworks/order_details'
 
 module FinerWorks
+  # The Client is the primary interface to the FinerWorks Web API.
+  #
+  # @attr [String] account_api_key A FinerWorks account API key.
   class Client
     attr_accessor :account_api_key
 
@@ -19,62 +22,75 @@ module FinerWorks
     end
 
     # Provides account profile information.
+    #
+    # @return [Account] Account information. Returns the account associated with the client's API key.
     def account
       result = FinerWorks::Request.get(self, "/Account")
       FinerWorks::Account.new(result.json)
     end
 
     # Updates account profile information.
+    #
+    # @param [Account] account Account information.
+    # @return [Response] API response.
     def update_account(account)
       result = FinerWorks::Request.post(self, "/Account", build_post_account_json(account))
     end
 
     # Lists prints stored in My Prints Inventory.
     #
-    # ==== Options hash:
-    # ["ImageGUID"] Filter by image.
-    # ["GalleryGUID"] Filter by gallery.
+    # @param [Hash] options Filtering options.
+    # @option options [String] "ImageGUID" Find prints based on a specific image.
+    # @option options [String] "GalleryGUID" Find prints whose images are under a specific gallery.
+    # @return [Array<Print>] A list of prints.
     def prints(options = {})
       get(FinerWorks::Print, "/Prints", options)
     end
 
     # Lists galleries (aka portfolios) under the current account.
+    #
+    # @return [Array<Gallery>] A list of galleries.
     def galleries
       get(FinerWorks::Gallery, "/Galleries")
     end
 
     # Lists images stored in My Images.
     #
-    # ==== Options hash:
-    # ["GalleryGUID"] Filter by gallery.
-    # ["Sort"] Sort images by upload date in ascending or descending order. Possible values are "ASC" and "DESC".
-    #          Default is descending.
+    # @param [Hash] options Filtering/sorting options.
+    # @option options [String] "GalleryGUID" Find images that are under a specific gallery.
+    # @option options [String] "Sort" ("DESC") Sort images by upload dates. Possible values are "ASC" or "DESC".
+    # @return [Array<Image>] A list of images.
     def images(options = {})
       get(FinerWorks::Image, "/Images", options)
     end
 
-    # Lists orders
+    # Lists orders.
     #
-    # ==== Options hash:
-    # ["OrderDateTime_Start"] Search for orders in the range starting at the specified date/time.
-    # ["OrderDateTime_End"] Search for orders in the range ending at the specified date/time.
-    # ["OrderStatusID"] Search for orders with a specific status.
-    # ["OrderID"] Find a specific order by ID.
-    # ["Sort"] Sort orders by ID in ascending or descending order. Possible values are "ASC" and "DESC". Default is
-    #          descending.
+    # @param [Hash] options Filtering/sorting options.
+    # @option options [String] "OrderDateTime_Start" Find orders in the time period starting at the specified date/time. Acceptable formats include "MM/DD/YYYY" or "YYYY-MM-DD".
+    # @option options [String] "OrderDateTime_End" Find orders in the time period ending at the specified date/time. Acceptable formats include "MM/DD/YYYY" or "YYYY-MM-DD".
+    # @option options [String] "OrderStatusID" Find orders with a specific status.
+    # @option options [String] "OrderID" Find a specific order by order ID.
+    # @option options [String] "Sort" ("DESC") Sort orders by ID. Possible values are "ASC" or "DESC".
+    # @return [Array<Order>] A list of orders.
     def orders(options = {})
       get(FinerWorks::Order, "/Orders", options)
     end
 
-    # Provides order details.
+    # Provides details for a specific order.
     #
-    # ==== Parameters:
-    # [id] Order ID number.
+    # @param id [Integer] Order ID number.
+    # @return [Array<OrderDetails>] Order details for the given order ID.
     def order_details(id)
       get(FinerWorks::OrderDetails, "/OrderDetails", { "OrderID" => id })
     end
 
     # Generic GET method to request items of the specified +type+. This always returns an +Array+.
+    #
+    # @param type [Class] Type of objects to return.
+    # @param path [String] API request path.
+    # @param [Hash] options Parameters to include in the request URI.
+    # @return [Array<Object>] A list of items.
     def get(type, path, options = {})
       response = FinerWorks::Request.get(self, path, options)
       items = response.json.kind_of?(Array) ? response.json : [response.json]

data/lib/finerworks/order_details.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 module FinerWorks
   class OrderDetails < Hashie::Trash
     property :id, from: "OrderID"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finerworks
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jeff Fredrickson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-22 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: This gem wraps the FinerWorks Web API in order to provide an easy way
   to utilize the API in Ruby apps.
 email:
@@ -108,9 +122,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -123,3 +137,4 @@ signing_key:
 specification_version: 4
 summary: Ruby interface for the FinerWorks Web API
 test_files: []
+has_rdoc: