rapa 0.2.1 → 0.3.0

data/lib/rapa/queries/base_query.rb

@@ -0,0 +1,120 @@
+require "cgi"
+require "time"
+
+module Rapa
+  module Queries
+    class BaseQuery
+      SERVICE = "AWSECommerceService"
+      VERSION = "2013-08-01"
+
+      class << self
+        attr_writer :property_names
+
+        # @note Override
+        def inherited(child_class)
+          child_class.property_names = property_names.clone
+        end
+
+        # @return [Array<Symbol>]
+        def property_names
+          @property_names ||= []
+        end
+
+        # @param property_name [Symbol]
+        def property(property_name)
+          property_names << property_name
+        end
+      end
+
+      property :AssociateTag
+      property :AWSAccessKeyId
+      property :Operation
+      property :RelatedItemPage
+      property :RelationshipType
+      property :ResponseGroup
+      property :Service
+      property :Timestamp
+      property :Version
+
+      # @param options [Hash]
+      def initialize(options = {})
+        @options = options
+      end
+
+      # @return [String]
+      def AssociateTag
+        options[:associate_tag]
+      end
+
+      # @return [String]
+      def AWSAccessKeyId
+        options[:access_key_id]
+      end
+
+      # @return [String]
+      def Operation
+        raise ::NotImplementedError
+      end
+
+      # @return [Integer, nil]
+      def RelatedItemPage
+        options[:related_item_page]
+      end
+
+      # @return [String, nil]
+      def RelationshipType
+        options[:relationship_type]
+      end
+
+      # @return [String, nil]
+      def ResponseGroup
+        if options[:response_groups]
+          options[:response_groups].join(",")
+        end
+      end
+
+      # @return [String]
+      def Service
+        SERVICE
+      end
+
+      # @return [String]
+      def Timestamp
+        ::Time.now.utc.iso8601
+      end
+
+      # @return [Hash]
+      def to_hash
+        self.class.property_names.each_with_object({}) do |property_name, result|
+          value = send(property_name)
+          unless value.nil?
+            result[property_name.to_s] = value
+          end
+        end.sort.to_h
+      end
+
+      # @return [String]
+      def to_s
+        to_hash.map do |key, value|
+          [
+            key,
+            ::CGI.escape(value),
+          ].join("=")
+        end.join("&")
+      end
+
+      # @return [String]
+      def Version
+        VERSION
+      end
+
+      private
+
+      # @private
+      # @return [Hash]
+      def options
+        @options
+      end
+    end
+  end
+end

data/lib/rapa/queries/list_items_query.rb

@@ -0,0 +1,19 @@
+module Rapa
+  module Queries
+    class ListItemsQuery < BaseQuery
+      OPERATION = "ItemLookup"
+
+      property :ItemId
+
+      # @return [String]
+      def ItemId
+        options[:asins].join(",")
+      end
+
+      # @note Override
+      def Operation
+        OPERATION
+      end
+    end
+  end
+end

data/lib/rapa/queries/search_items_query.rb

@@ -0,0 +1,26 @@
+module Rapa
+  module Queries
+    class SearchItemsQuery < BaseQuery
+      SEARCH_INDEX_DEFAULT = "All"
+      OPERATION = "ItemSearch"
+
+      property :Keywords
+      property :SearchIndex
+
+      # @return [Array<String>]
+      def Keywords
+        options[:keywords].join(",")
+      end
+
+      # @note Override
+      def Operation
+        OPERATION
+      end
+
+      # @return [String]
+      def SearchIndex
+        options[:search_index] || SEARCH_INDEX_DEFAULT
+      end
+    end
+  end
+end

data/lib/rapa/resources/base_resource.rb

@@ -0,0 +1,15 @@
+module Rapa
+  module Resources
+    class BaseResource
+      # @param source [Hash]
+      def initialize(source)
+        @source = source
+      end
+
+      # @return [Hash]
+      def source
+        @source
+      end
+    end
+  end
+end

data/lib/rapa/resources/item_resource.rb

@@ -0,0 +1,357 @@
+require "date"
+
+module Rapa
+  module Resources
+    class ItemResource < BaseResource
+      # @return [Boolean, nil]
+      def adult_product?
+        if flag_source = source.dig("ItemAttributes", "IsAdultProduct")
+          flag_source != "0"
+        end
+      end
+
+      # @return [Array<Rapa::AlternateVersion>, nil]
+      def alternate_versions
+        if alternate_version_sources = source.dig("AlternateVersions", "AlternateVersion")
+          ::Array.wrap(alternate_version_sources).map do |alternate_version_source|
+            ::Rapa::AlternateVersion.new(alternate_version_source)
+          end
+        end
+      end
+
+      # @return [String]
+      def asin
+        source["ASIN"]
+      end
+
+      # @return [Array<String>, nil]
+      def authors
+        if author_sources = source.dig("ItemAttributes", "Author")
+          Array(author_sources)
+        end
+      end
+
+      # @return [String, nil]
+      def binding
+        source.dig("ItemAttributes", "Binding")
+      end
+
+      # @return [Array, nil]
+      def browse_nodes
+        source.dig("BrowseNodes", "BrowseNode")
+      end
+
+      # @return [String, nil]
+      def creator_name
+        source.dig("ItemAttributes", "Creator", "__content__")
+      end
+
+      # @return [String, nil]
+      def creator_role
+        source.dig("ItemAttributes", "Creator", "Role")
+      end
+
+      # @return [String, nil]
+      def ean
+        source.dig("ItemAttributes", "EAN")
+      end
+
+      # @return [Integer, nil]
+      def episode_sequence
+        if value = source.dig("ItemAttributes", "EpisodeSequence")
+          value.to_i
+        end
+      end
+
+      # @return [String, nil]
+      def genre
+        source.dig("ItemAttributes", "Genre")
+      end
+
+      # @return [Boolean]
+      def has_customer_reviews?
+        source.dig("CustomerReviews", "HasReviews") == "true"
+      end
+
+      # @return [Rapa::Image, nil]
+      def image_hi_res
+        find_image("HiResImage")
+      end
+
+      # @return [Rapa::Image, nil]
+      def image_large
+        find_image("LargeImage")
+      end
+
+      # @return [Rapa::Image, nil]
+      def image_medium
+        find_image("MediumImage")
+      end
+
+      # @return [Rapa::Image, nil]
+      def image_small
+        find_image("SmallImage")
+      end
+
+      # @return [Rapa::Image, nil]
+      def image_swatch
+        find_image("SwatchImage")
+      end
+
+      # @return [Rapa::Image, nil]
+      def image_thumbnail
+        find_image("ThumbnailImage")
+      end
+
+      # @return [Rapa::Image, nil]
+      def image_tiny
+        find_image("TinyImage")
+      end
+
+      # @return [String, nil]
+      def isbn
+        source.dig("ItemAttributes", "ISBN")
+      end
+
+      # @return [Rapa::Quantity]
+      def item_height
+        if quantity_source = source.dig("ItemAttributes", "ItemDimensions", "Height")
+          ::Rapa::Quantity.new(quantity_source)
+        end
+      end
+
+      # @return [Rapa::Quantity]
+      def item_length
+        if quantity_source = source.dig("ItemAttributes", "ItemDimensions", "Length")
+          ::Rapa::Quantity.new(quantity_source)
+        end
+      end
+
+      # @return [Rapa::Quantity]
+      def item_width
+        if quantity_source = source.dig("ItemAttributes", "ItemDimensions", "Width")
+          ::Rapa::Quantity.new(quantity_source)
+        end
+      end
+
+      # @return [String, nil]
+      def label
+        source.dig("ItemAttributes", "Label")
+      end
+
+      # @return [Array<Rapa::Language>, nil]
+      def languages
+        if language_sources = source.dig("ItemAttributes", "Languages", "Language")
+          language_sources.map do |language_source|
+            ::Rapa::Language.new(language_source)
+          end
+        end
+      end
+
+      # @return [String, nil]
+      def manufacturer
+        source.dig("ItemAttributes", "Manufacturer")
+      end
+
+      # @return [Integer, nil]
+      def number_of_pages
+        if value = source.dig("ItemAttributes", "NumberOfPages")
+          value.to_i
+        end
+      end
+
+      # @return [Rapa::Quantity]
+      def package_height
+        if quantity_source = source.dig("ItemAttributes", "PackageDimensions", "Height")
+          ::Rapa::Quantity.new(quantity_source)
+        end
+      end
+
+      # @return [Rapa::Quantity]
+      def package_length
+        if quantity_source = source.dig("ItemAttributes", "PackageDimensions", "Length")
+          ::Rapa::Quantity.new(quantity_source)
+        end
+      end
+
+      # @return [Rapa::Quantity]
+      def package_weight
+        if quantity_source = source.dig("ItemAttributes", "PackageDimensions", "Weight")
+          ::Rapa::Quantity.new(quantity_source)
+        end
+      end
+
+      # @return [Rapa::Quantity]
+      def package_width
+        if quantity_source = source.dig("ItemAttributes", "PackageDimensions", "Width")
+          ::Rapa::Quantity.new(quantity_source)
+        end
+      end
+
+      # @return [String, nil]
+      def product_group
+        source.dig("ItemAttributes", "ProductGroup")
+      end
+
+      # @return [String, nil]
+      def product_type_name
+        source.dig("ItemAttributes", "ProductTypeName")
+      end
+
+      # @return [Date, nil]
+      def publication_date
+        if value = source.dig("ItemAttributes", "PublicationDate")
+          ::Date.parse(value)
+        end
+      end
+
+      # @return [String, nil]
+      def publisher
+        source.dig("ItemAttributes", "Publisher")
+      end
+
+      # @return [Integer, nil]
+      def related_item_count
+        if value = source.dig("RelatedItems", "RelatedItemCount")
+          value.to_i
+        end
+      end
+
+      # @return [Integer, nil]
+      def related_item_page
+        if value = source.dig("RelatedItems", "RelatedItemPage")
+          value.to_i
+        end
+      end
+
+      # @return [Integer, nil]
+      def related_item_page_count
+        if value = source.dig("RelatedItems", "RelatedItemPageCount")
+          value.to_i
+        end
+      end
+
+      # @return [Array<Rapa::Resources::ItemResource>, nil]
+      def related_items
+        if source_or_sources = source.dig("RelatedItems", "RelatedItem")
+          if source_or_sources.is_a?(::Array)
+            source_or_sources
+          else
+            [source_or_sources]
+          end.map do |related_item_source|
+            ::Rapa::Resources::ItemResource.new(related_item_source["Item"])
+          end
+        end
+      end
+
+      # @return [String, nil]
+      def relationship
+        source.dig("RelatedItems", "Relationship")
+      end
+
+      # @return [String, nil]
+      def relationship_type
+        source.dig("RelatedItems", "RelationshipType")
+      end
+
+      # @return [Date, nil]
+      def release_date
+        if value = source.dig("ItemAttributes", "ReleaseDate")
+          ::Date.parse(value)
+        end
+      end
+
+      # @return [Rapa::Quantity, nil]
+      def running_time
+        if value = source.dig("ItemAttributes", "RunningTime")
+          ::Rapa::Quantity.new(value)
+        end
+      end
+
+      # @return [Integer, nil]
+      def sales_rank
+        source["SalesRank"]
+      end
+
+      # @return [Integer, nil]
+      def season_sequence
+        if value = source.dig("ItemAttributes", "SeasonSequence")
+          value.to_i
+        end
+      end
+
+      # @return [Array<Rapa::SimilarProduct>, nil]
+      def similar_products
+        if similar_product_sources = source["SimilarProducts"]
+          similar_product_sources.map do |similar_product_source|
+            ::Rapa::SimilarProduct.new(similar_product_source)
+          end
+        end
+      end
+
+      # @return [String, nil]
+      def studio
+        source.dig("ItemAttributes", "Studio")
+      end
+
+      # @return [String, nil]
+      def title
+        source.dig("ItemAttributes", "Title")
+      end
+
+      # @return [String, nil]
+      def url_add_to_wishlist
+        item_links["Add To Wishlist"]
+      end
+
+      # @return [String, nil]
+      def url_all_customer_reviews
+        item_links["All Customer Reviews"]
+      end
+
+      # @return [String, nil]
+      def url_all_offers
+        item_links["All Offers"]
+      end
+
+      # @return [String, nil]
+      def url_customer_reviews_iframe
+        source.dig("CustomerReviews", "IFrameURL")
+      end
+
+      # @return [String]
+      def url_details_page
+        source["DetailPageURL"]
+      end
+
+      # @return [String, nil]
+      def url_tell_a_friend
+        item_links["Tell A Friend"]
+      end
+
+      private
+
+      # @param key [String]
+      # @return [Rapa::Image, nil]
+      def find_image(key)
+        if image_source = (source[key] || source.dig("ImageSets", "ImageSet", key))
+          ::Rapa::Image.new(image_source)
+        end
+      end
+
+      # @private
+      # @return [Hash, nil]
+      def item_attributes
+        source["ItemAttributes"]
+      end
+
+      # @private
+      # @return [Hash]
+      def item_links
+        @item_links ||= source["ItemLinks"]["ItemLink"].each_with_object({}) do |element, result|
+          result[element["Description"]] = element["URL"]
+        end
+      end
+    end
+  end
+end

data/lib/rapa/responses/base_response.rb

@@ -0,0 +1,70 @@
+module Rapa
+  module Responses
+    class BaseResponse
+      include ::Enumerable
+
+      # @param faraday_response [Faraday::Response]
+      def initialize(faraday_response)
+        @faraday_response = faraday_response
+      end
+
+      # @return [String]
+      def body
+        faraday_response.body
+      end
+
+      # @note Implementation for Enumerable
+      def each(&block)
+        resources.each(&block)
+      end
+
+      # @return [Faraday::Utils::Headers]
+      def headers
+        faraday_response.headers
+      end
+
+      # @return [Array<Rapa::Resources::ItemResource>]
+      def resources
+        sources.map do |source|
+          resource_class.new(source)
+        end
+      end
+
+      # @return [Integer]
+      def status
+        faraday_response.status
+      end
+
+      private
+
+      # @private
+      # @return [Faraday::Response]
+      def faraday_response
+        @faraday_response
+      end
+
+      # @return [Class]
+      def resource_class
+        raise ::NotImplementedError
+      end
+
+      # @private
+      def source_or_sources
+        raise ::NotImplementedError
+      end
+
+      # @private
+      # @return [Array<Hash>]
+      def sources
+        case source_or_sources
+        when ::Array
+          source_or_sources
+        when nil
+          []
+        else
+          [source_or_sources]
+        end
+      end
+    end
+  end
+end

data/lib/rapa/responses/list_items_response.rb

@@ -0,0 +1,17 @@
+module Rapa
+  module Responses
+    class ListItemsResponse < BaseResponse
+      private
+
+      # @note Override
+      def resource_class
+        ::Rapa::Resources::ItemResource
+      end
+
+      # @note Override
+      def source_or_sources
+        body.dig("ItemLookupResponse", "Items", "Item")
+      end
+    end
+  end
+end

data/lib/rapa/responses/search_items_response.rb

@@ -0,0 +1,48 @@
+module Rapa
+  module Responses
+    class SearchItemsResponse < BaseResponse
+      # @return [Rapa::Error]
+      def error
+        if value = body.dig("ItemSearchResponse", "Items", "Request", "Errors", "Error")
+          ::Rapa::Error.new(value)
+        end
+      end
+
+      # @return [Boolean]
+      def has_error?
+        !error.nil?
+      end
+
+      # @return [Boolean]
+      def has_valid_request?
+        body.dig("ItemSearchResponse", "Items", "Request", "IsValid") == "True"
+      end
+
+      # @return [Integer, nil]
+      def total_pages
+        if value = body.dig("ItemSearchResponse", "Items", "TotalPages")
+          value.to_i
+        end
+      end
+
+      # @return [Integer, nil]
+      def total_results
+        if value = body.dig("ItemSearchResponse", "Items", "TotalResults")
+          value.to_i
+        end
+      end
+
+      private
+
+      # @note Override
+      def resource_class
+        ::Rapa::Resources::ItemResource
+      end
+
+      # @note Override
+      def source_or_sources
+        body.dig("ItemSearchResponse", "Items", "Item")
+      end
+    end
+  end
+end