brickset_api 0.1.0

data/lib/brickset/api/set.rb

@@ -0,0 +1,157 @@
+module Brickset
+  module Api
+    module Set
+      extend ActiveSupport::Concern
+
+      module Order
+        module Types
+          NUMBER          = 'number'
+          NAME            = 'name'
+          THEME           = 'theme'
+          PIECES          = 'pieces'
+          RATING          = 'rating'
+          SUBTHEME        = 'subtheme'
+          MINIFIGS        = 'minifigs'
+          YEAR_FROM       = 'yearfrom'
+          RETAIL_PRICE_UK = 'ukretailprice'
+          RETAIL_PRICE_US = 'usretailprice'
+          RETAIL_PRICE_CA = 'caretailprice'
+          RETAIL_PRICE_EU = 'euretailprice'
+          RANDOM          = 'random'
+          ALL             = constants(false).map { |constant| const_get(constant) }
+        end
+
+        module Direction
+          ASC             = 'asc'
+          DESC            = 'desc'
+          ALL             = constants(false).map { |constant| const_get(constant) }
+        end
+      end
+
+      included do
+        attr_accessor :set_number, :year, :page_size, :page_number, :order_by, :order_direction, :set_id, :minutes_ago
+
+        with_options(on: :sets) do |options|
+          options.validates :set_number, format: { with: /\A\w+-\d+\z/, message: 'format of <number>-<variant>, e.g. 75192-1 or darthvader-1' }, allow_blank: true
+          options.validates :page_size, :page_number, numericality: { only_integer: true }
+          options.validates :order_by, inclusion: { in: Order::Types::ALL }
+          options.validates :order_direction, inclusion: { in: Order::Direction::ALL }
+        end
+
+        validates :set_id, numericality: { only_integer: true }, on: [:set, :additional_images, :reviews, :instructions]
+        validates :minutes_ago, numericality: { only_integer: true }, on: :recently_updated_sets
+      end
+
+      def sets(query: '', theme: '', subtheme: '', set_number: '', year: '', owned: '', wanted: '', order_by: 'number', page_size: 20, page_number: 1, username: '', order_direction: Order::Direction::ASC)
+        self.set_number = set_number
+        self.page_size = page_size
+        self.page_number = page_number
+        self.order_by = order_by
+        self.order_direction = order_direction
+
+        if valid?(:sets)
+          # NOTE: all of the parameters are required, even though the API specifies them as optional.
+          xml = call('/getSets', query: query, theme: theme, subtheme: subtheme, setNumber: set_number, year: year, owned: owned, wanted: wanted, orderBy: order, pageSize: page_size, pageNumber: page_number, userName: username)
+          Brickset::Elements::Set.parse(xml)
+        else
+          raise ValidationError, self.errors.full_messages.to_sentence
+        end
+      end
+
+      def set(set_id)
+        self.set_id = set_id
+
+        if valid?(:set)
+          xml = call('/getSet', setID: set_id)
+          Brickset::Elements::Set.parse(xml, single: true)
+        else
+          raise ValidationError, self.errors.full_messages.to_sentence
+        end
+      end
+
+      def recently_updated_sets(minutes_ago)
+        self.minutes_ago = minutes_ago
+
+        if valid?(:recently_updated_sets)
+          xml = call('/getRecentlyUpdatedSets', minutesAgo: minutes_ago)
+          Brickset::Elements::Set.parse(xml)
+        else
+          raise ValidationError, self.errors.full_messages.to_sentence
+        end
+      end
+
+      def additional_images(set_id)
+        self.set_id = set_id
+
+        if valid?(:additional_images)
+          xml = call('/getAdditionalImages', setID: set_id)
+          Brickset::Elements::AdditionalImage.parse(xml)
+        else
+          raise ValidationError, self.errors.full_messages.to_sentence
+        end
+      end
+
+      def reviews(set_id)
+        self.set_id = set_id
+
+        if valid?(:reviews)
+          xml = call('/getReviews', setID: set_id)
+          Brickset::Elements::Review.parse(xml)
+        else
+          raise ValidationError, self.errors.full_messages.to_sentence
+        end
+      end
+
+      def instructions(set_id)
+        self.set_id = set_id
+
+        if valid?(:instructions)
+          xml = call('/getInstructions', setID: set_id)
+          Brickset::Elements::Instruction.parse(xml)
+        else
+          raise ValidationError, self.errors.full_messages.to_sentence
+        end
+      end
+
+      def themes
+        xml = call('/getThemes')
+        Brickset::Elements::Theme.parse(xml)
+      end
+
+      def subthemes(theme)
+        xml = call('/getSubthemes', theme: theme)
+        Brickset::Elements::Subtheme.parse(xml)
+      end
+
+      def years(theme)
+        xml = call('/getYears', theme: theme)
+        Brickset::Elements::Year.parse(xml)
+      end
+
+      def themes_for_user(owned: '', wanted: '')
+        xml = call('/getThemesForUser', owned: owned, wanted: wanted)
+        Brickset::Elements::Theme.parse(xml)
+      end
+
+      def subthemes_for_user(theme, owned: '', wanted: '')
+        xml = call('/getSubthemesForUser', theme: theme, owned: owned, wanted: wanted)
+        Brickset::Elements::Subtheme.parse(xml)
+      end
+
+      def years_for_user(theme, owned: '', wanted: '')
+        xml = call('/getYearsForUser', theme: theme, owned: owned, wanted: wanted)
+        Brickset::Elements::Year.parse(xml)
+      end
+
+      private
+
+      def order
+        if order_direction == Order::Direction::DESC
+          [ order_by, order_direction.upcase ].join
+        else
+          order_by
+        end
+      end
+    end
+  end
+end

data/lib/brickset/client.rb

@@ -0,0 +1,56 @@
+module Brickset
+  class Client
+    include HTTParty
+    include ActiveModel::Validations
+
+    include Brickset::Api::Auth
+    include Brickset::Api::Set
+    include Brickset::Api::Collection::Set
+    include Brickset::Api::Collection::Minifig
+    include Brickset::Api::Collection::Advanced
+
+    base_uri Brickset::BASE_URI
+
+    attr_reader :token
+
+    def initialize(options = {})
+      @token = options[:token] if options.key?(:token)
+    end
+
+    private
+
+    def call(method, options = {})
+      response = self.class.post(method, { body: options.merge(default_options) })
+
+      if response.code == 200
+        response.body
+      else
+        raise response.body
+      end
+    end
+
+    def handle_update(response)
+      content = HappyMapper.parse(response).content
+
+      if content == 'OK'
+        true
+      else
+        errors.add(:base, content)
+        false
+      end
+    end
+
+    def extract_attributes_from_options(options)
+      options.each do |key, value|
+        raise KeyError, "Attribute key '#{key}' is not supported" unless respond_to?("#{key}=")
+        send("#{key}=", value)
+      end
+    end
+
+    def default_options
+      options = { apiKey: Brickset.configuration.api_key }
+      options.merge!(userHash: token) if token
+      options
+    end
+  end
+end

data/lib/brickset/configuration.rb

@@ -0,0 +1,9 @@
+module Brickset
+  class Configuration
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = nil
+    end
+  end
+end

data/lib/brickset/elements/additional_image.rb

@@ -0,0 +1,13 @@
+module Brickset
+  module Elements
+    class AdditionalImage
+      include HappyMapper
+
+      tag 'additionalImages'
+
+      element :thumbnail_url, String, tag: 'thumbnailURL'
+      element :thumbnail_url_large, String, tag: 'largeThumbnailURL'
+      element :image_url, String, tag: 'imageURL'
+    end
+  end
+end

data/lib/brickset/elements/collection_detail.rb

@@ -0,0 +1,28 @@
+module Brickset
+  module Elements
+    class CollectionDetail
+      include HappyMapper
+
+      tag 'collectionDetails'
+
+      element :collection_id, Integer, tag: 'collectionID'
+      element :date_acquired, String, tag: 'dateAcquired'
+      element :currency, String
+      element :price_paid, Float, tag: 'pricePaid'
+      element :additional_price_paid, Float, tag: 'additionalPricePaid'
+      element :current_estimated_value, Float, tag: 'currentEstimatedValue'
+      element :condition_when_acquired, String, tag: 'conditionWhenAcquired'
+      element :acquired_from, String, tag: 'acquiredFrom'
+      element :condition_now, String, tag: 'conditionNow'
+      element :location, String
+      element :notes, String
+      element :parts, Boolean
+      element :minifigs, Boolean
+      element :instructions, Boolean
+      element :box, Boolean
+      element :modified, Boolean
+      element :will_trade, Boolean, tag: 'willTrade'
+      element :deleted, Boolean
+    end
+  end
+end

data/lib/brickset/elements/collection_total.rb

@@ -0,0 +1,15 @@
+module Brickset
+  module Elements
+    class CollectionTotal
+      include HappyMapper
+
+      tag 'collectionTotals'
+
+      element :total_sets_owned, Integer, tag: 'totalSetsOwned'
+      element :total_sets_wanted, Integer, tag: 'totalSetsWanted'
+      element :total_distinct_sets_owned, Integer, tag: 'totalDistinctSetsOwned'
+      element :total_minifigs_owned, Integer, tag: 'totalMinifigsOwned'
+      element :total_minifigs_wanted, Integer, tag: 'totalMinifigsWanted'
+    end
+  end
+end

data/lib/brickset/elements/condition.rb

@@ -0,0 +1,11 @@
+module Brickset
+  module Elements
+    class Condition
+      include HappyMapper
+
+      tag 'conditions'
+
+      element :condition, String
+    end
+  end
+end

data/lib/brickset/elements/instruction.rb

@@ -0,0 +1,12 @@
+module Brickset
+  module Elements
+    class Instruction
+      include HappyMapper
+
+      tag 'instructions'
+
+      element :url, String, tag: 'URL'
+      element :description, String
+    end
+  end
+end

data/lib/brickset/elements/minifig_collection.rb

@@ -0,0 +1,15 @@
+module Brickset
+  module Elements
+    class MinifigCollection
+      include HappyMapper
+
+      tag 'minifigCollection'
+
+      element :minifig_number, String, tag: 'minifigNumber'
+      element :owned_in_sets, Integer, tag: 'ownedInSets'
+      element :owned_loose, Integer, tag: 'ownedLoose'
+      element :owned_total, Integer, tag: 'ownedTotal'
+      element :wanted, Boolean
+    end
+  end
+end

data/lib/brickset/elements/review.rb

@@ -0,0 +1,20 @@
+module Brickset
+  module Elements
+    class Review
+      include HappyMapper
+
+      tag 'reviews'
+
+      element :author, String
+      element :title, String
+      element :review, String
+      element :date_posted, Date, tag: 'datePosted'
+      element :overall_rating, Integer, tag: 'overallRating'
+      element :parts, Integer
+      element :building_experience, Integer, tag: 'buildingExperience'
+      element :playability, Integer
+      element :value_for_money, Integer, tag: 'valueForMoney'
+      element :html, Boolean, tag: 'HTML'
+    end
+  end
+end

data/lib/brickset/elements/set.rb

@@ -0,0 +1,67 @@
+module Brickset
+  module Elements
+    class Set
+      include HappyMapper
+
+      tag 'sets'
+
+      element :id, Integer, tag: 'setID'
+      element :number, String
+      element :number_variant, Integer, tag: 'numberVariant'
+      element :name, String
+      element :year, String
+      element :description, String
+      element :category, String
+      element :theme, String
+      element :theme_group, String, tag: 'themeGroup'
+      element :subtheme, String, tag: 'subtheme'
+      element :pieces, String
+      element :minifigs, String
+      element :image, Boolean
+      element :image_url, String, tag: 'imageURL'
+      element :image_filename, String, tag: 'imageFilename'
+      element :thumbnail_url, String, tag: 'thumbnailURL'
+      element :thumbnail_url_large, String, tag: 'largeThumbnailURL'
+      element :brickset_url, String, tag: 'bricksetURL'
+      element :owned_by_total, Integer, tag: 'ownedByTotal'
+      element :wanted_by_total, Integer, tag: 'wantedByTotal'
+      element :released, Boolean
+      element :rating, Float
+      element :user_rating, Integer, tag: 'userRating'
+      element :review_count, Integer, tag: 'reviewCount'
+      element :instructions_count, Integer, tag: 'instructionsCount'
+      element :additional_image_count, Integer, tag: 'additionalImageCount'
+      element :last_updated, Date, tag: 'lastUpdated'
+      element :age_minimum, Integer, tag: 'ageMin'
+      element :age_maximum, Integer, tag: 'ageMax'
+      element :notes, String
+      element :tags, String
+
+      # retail related.
+
+      element :retail_price_uk, String, tag: 'UKRetailPrice'
+      element :retail_price_us, String, tag: 'USRetailPrice'
+      element :retail_price_ca, String, tag: 'CARetailPrice'
+      element :retail_price_eu, String, tag: 'EURetailPrice'
+      element :date_added_to_shop, String, tag: 'USDateAddedToSAH'
+      element :date_removed_from_shop, String, tag: 'USDateRemovedFromSAH'
+      element :packaging_type, String, tag: 'packagingType'
+      element :height, Float
+      element :width, Float
+      element :depth, Float
+      element :weight, Float
+      element :availability, String
+      element :ean, String, tag: 'EAN'
+      element :upc, String, tag: 'UPC'
+
+      element :acm_data_count, Integer, tag: 'ACMDataCount'
+
+      # requires authentication.
+
+      element :owned, Boolean
+      element :wanted, Boolean
+      element :number_owned, Integer, tag: 'qtyOwned'
+      element :user_notes, String, tag: 'userNotes'
+    end
+  end
+end

data/lib/brickset/elements/subtheme.rb

@@ -0,0 +1,15 @@
+module Brickset
+  module Elements
+    class Subtheme
+      include HappyMapper
+
+      tag 'subthemes'
+
+      element :theme, String
+      element :subtheme, String
+      element :set_count, Integer, tag: 'setCount'
+      element :year_from, Integer, tag: 'yearFrom'
+      element :year_to, Integer, tag: 'yearTo'
+    end
+  end
+end

data/lib/brickset/elements/theme.rb

@@ -0,0 +1,15 @@
+module Brickset
+  module Elements
+    class Theme
+      include HappyMapper
+
+      tag 'themes'
+
+      element :theme, String
+      element :set_count, Integer, tag: 'setCount'
+      element :subtheme_count, Integer, tag: 'subthemeCount'
+      element :year_from, Integer, tag: 'yearFrom'
+      element :year_to, Integer, tag: 'yearTo'
+    end
+  end
+end