aboutyou-sdk 0.0.29 → 0.0.30

data/lib/AboutYou/Model/variants_result.rb

@@ -2,23 +2,24 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents a variants result
-      #
       ###
       class VariantsResult
-        # @var Variant[] */
+        # Array of AboutYou::SDK::Model::Variant
         attr_accessor :variants
-        # @var array */
+        # Array of Errors
         attr_accessor :errors
 
         ###
+        # This method is used for creating the variants result
         #
-        # @param \stdClass $json_object
-        # @param \Collins\ShopApi\Model\ModelFactoryInterface $factory
-        # @param \Collins\ShopApi\Model\ProductSearchResult $productSearchResult
+        # * *Args*    :
+        #   - +variants+ -> Array of AboutYou::SDK::Model::Variant 
+        #   - +errors+ -> Array of Errors [optional]
+        #   - +product_search_result+ -> AboutYou::SDK::Model::ProductSearchResult [optional]
         #
-        # @return static
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::VariantsResult
         ###
         def self.create(variants, errors = [], product_search_result)
           variants_result = new
@@ -49,38 +50,53 @@ module AboutYou
         end
 
         ###
-        # @return bool
+        # This method checks if there are variants found
+        #
+        # * *Returns* :
+        #   - Boolean determining whether the result has found variants or not
         ###
         def variants_found?
           variants.count > 0
         end
 
         ###
-        # @return bool
+        # This method checks if there are variants not found
+        #
+        # * *Returns* :
+        #   - Boolean determining whether the result has not found variants or not
         ###
         def variants_not_found?
           errors.count > 0
         end
 
         ###
-        # @return Variant[]
+        # Getter for the found variants
+        #
+        # * *Returns* :
+        #   - Array of AboutYou::SDK::Model::Variant
         ###
         def variants_found
           variants
         end
 
         ###
-        # @param int $id
+        # This method searches for a variant by a certain variant_id
         #
-        #
-        # @return Variant|null
+        # * *Args* :
+        #   - +id+ -> id used for searching 
+
+        # * *Returns* :
+        #   - nil / instance of AboutYou::SDK::Model::Variant
         ###
         def variant_by_id(id)
           variants[id] ? variants[id] : nil
         end
 
         ###
-        # @return int[]
+        # geter for the not found variants
+        #
+        # * *Returns* :
+        #   - Array of AboutYou::SDK::Model::Variant
         ###
         def variants_not_found
           errors

data/lib/AboutYou/client.rb

@@ -1,4 +1,7 @@
 module AboutYou
+  ###
+  # The SDK namespace
+  ###
   module SDK
     ###
     # This Class manages the API-Calls
@@ -83,6 +86,10 @@ module AboutYou
       # * *Args*    :
       #   - +body+ -> the body of the api-call, containing all request data
       #
+      # * *Fails* :
+      #   - if the http response code is not between 200 and 300 or 304
+      #   - if the body of the http response is not an array
+      #
       # * *Returns* :
       #   - Json-String containing the response-body
       ###

data/lib/AboutYou/query.rb

@@ -19,8 +19,7 @@ module AboutYou
       attr_accessor :client
       # the query built by the app itself
       attr_accessor :query
-      # a Hash containing the mapping for
-      # api_call_name => method_name_in_model_factory
+      # a Hash containing the mapping for api_call_name => method_name_in_model_factory
       attr_accessor :mapping
       # the model factory which builds the models from the api-response
       attr_accessor :factory
@@ -261,6 +260,12 @@ module AboutYou
       #
       # * *Args*    :
       #   - +jsonResponse+ -> the plain json received from the api
+      #
+      # * *Fails* :
+      #   - if the response is false, not an array or has a different amount of subresponses then requests
+      #   - if there is any subresponse which was not requested
+      #   - if there is no model factory mapping for a subresponse
+      #
       ###
       def check_response(json_response)
         fail 'UnexpectedResultException!' if

data/lib/AboutYou/query_builder.rb

@@ -15,6 +15,10 @@ module AboutYou
       #   - +limit+ -> Maximum number of results [optional]
       #   - +types+ -> Array of types to search for [optional]
       #
+      # * *Fails* :
+      #   - if the searchword is not a String
+      #   - if the limit cant be transformed into an integer
+      #
       # * *Returns* :
       #   - Instance of AboutYou::SDK::Query
       ###
@@ -236,6 +240,9 @@ module AboutYou
       # * *Args*    :
       #   - +ids+ -> either a single category ID as integer or an array of IDs
       #
+      # * *Fails* :
+      #   - if a category id is smaller then 1
+      #
       # * *Returns* :
       #   - Instance of AboutYou::SDK::Query
       ###
@@ -445,6 +452,9 @@ module AboutYou
       # * *Args*    :
       #   - +params+ -> Hash containing 2 keys: "id", "group_id"
       #
+      # * *Fails* :
+      #   - if params is not set
+      #
       # * *Returns* :
       #   - Instance of AboutYou::SDK::Query
       ###
@@ -498,6 +508,9 @@ module AboutYou
       #   - +searchword+ -> the search string to search for
       #   - +category_ids+ -> the cat ids to filter for
       #
+      # * *Fails* :
+      #   - if the searchword is not a String
+      #
       # * *Returns* :
       #   - Instance of AboutYou::SDK::Query
       ###
@@ -548,10 +561,16 @@ module AboutYou
       #
       # * *Args*    :
       #   - +session_id+ -> the session id of a user
+      #
+      # * *Fails* :
+      #   - if the session id is not a String
+      #   - if the session id has less then 4 characters
       ###
-      def check_session_id(sessionId)
-        fail 'InvalidArgumentException! The session id must be a string' unless sessionId.is_a? String
-        fail 'InvalidArgumentException! The session id must have at least 5 characters' unless sessionId.length > 4
+      def check_session_id(session_id)
+        fail 'InvalidArgumentException! The session id must be a string' unless
+        session_id.is_a? String
+        fail 'InvalidArgumentException! The session id must have at least
+          5 characters' unless session_id.length > 4
       end
     end
   end

data/lib/aboutyou-sdk.rb

@@ -111,6 +111,9 @@ class AY
   #   - +variant_id+ -> Id of the Variant which should be added to the basket
   #   - +amount+ -> The Amount of the Item which should be added to the basket
   #
+  # * *Fails* :
+  #   - if the variant id cant be transformed into an Integer
+  #
   # * *Returns* :
   #   - Instance of AboutYou::SDK::Model::Basket
   ###
@@ -232,6 +235,10 @@ class AY
   #   - +searchword+ -> The prefix search word to search for
   #   - +category_ids+ -> The category ids used as a filter [optional]
   #
+  # * *Fails* :
+  #   - if a category id cant be transformed into an Integer
+  #   - if a category id is smaller then 1
+  #
   # * *Returns* :
   #   - Array of Strings
   ###

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aboutyou-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.29
+  version: 0.0.30
 platform: ruby
 authors:
 - Ferenc Beutel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -92,7 +92,7 @@ files:
 - lib/AboutYou/Model/order.rb
 - lib/AboutYou/Model/product.rb
 - lib/AboutYou/Model/product_search_result.rb
-- lib/AboutYou/Model/products_ean_result.rb
+- lib/AboutYou/Model/products_eans_result.rb
 - lib/AboutYou/Model/products_result.rb
 - lib/AboutYou/Model/result_error.rb
 - lib/AboutYou/Model/variant.rb