brickset 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f55c7c715d91ac8a0c2b8755551d0f6e189fc4b1
+  data.tar.gz: e8145706a24774fae35cdd560f5e94bb545cbc97
+SHA512:
+  metadata.gz: f43eef90c5b681308f333818f2db1938c1bda47f1575a221daaf59f10f6dfd9523c82faef8038e2d325bf8fcf6c4c072cedb3d037f616ddfc87e45559af0684f
+  data.tar.gz: f6bd38d8c17856f8c3dc1733e1d9fbaef6dfd5cbd9e014a81e271faab8cb6eb3d5e597509df7c719a0939522d25348f939847e5e2ef6a78850b9288a54c214a0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in brickset.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 dbwinger
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# BricksetRubyApi
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'brickset'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brickset
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/brickset/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/brickset.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brickset/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "brickset"
+  spec.version       = Brickset::VERSION
+  spec.authors       = ["dbwinger"]
+  spec.email         = ["dbwinger@gmail.com"]
+  spec.summary       = %q{Ruby wrapper for the Brickset.com v2 API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+  
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "httparty"
+end

data/lib/brickset.rb

@@ -0,0 +1,8 @@
+require 'byebug'
+require "brickset/version"
+require "brickset/configuration"
+require "brickset/client"
+
+module Brickset
+  extend Configuration
+end

data/lib/brickset/client.rb

@@ -0,0 +1,54 @@
+require "httparty"
+
+module Brickset
+  class Client
+    include HTTParty
+
+    # Define the same set of accessors as the Awesome module
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+    
+    def initialize(options = {})
+      # Merge the config values from the module and those passed
+      # to the client.
+      merged_options = Brickset.options.merge(options)
+
+      # Copy the merged values to this client and ignore those
+      # not part of our configuration
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    def get_sets options
+      required_params = [:userHash, :query, :theme, :subtheme, :setNumber, :year, :owned, :wanted, :orderBy, :pageSize, :pageNumber, :userName]
+      default_options = {}
+      required_params.each { |param| default_options[param] = nil }
+      response = call_api(:getSets, default_options.merge(options))
+      if response["ArrayOfSets"].nil?
+        []
+      else
+        response["ArrayOfSets"]["sets"] 
+      end
+    end
+
+    def get_recently_updated_sets minutes_ago
+      response = call_api :getRecentlyUpdatedSets, {minutesAgo: minutes_ago}
+      if response["ArrayOfSets"].nil?
+        []
+      else
+        response["ArrayOfSets"]["sets"] 
+      end
+    end
+
+    protected
+
+    def call_api method, options = {}
+      response = self.class.get("#{endpoint}/#{method.to_s}", query: options.merge(apiKey: api_key))
+      if response.code == 200
+        response.parsed_response
+      else
+        raise response.body
+      end
+    end
+  end
+end

data/lib/brickset/configuration.rb

@@ -0,0 +1,37 @@
+module Brickset
+  module Configuration
+    VALID_CONNECTION_KEYS = [:endpoint, :user_agent, :method].freeze
+    VALID_OPTIONS_KEYS    = [:api_key].freeze
+    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+ 
+    DEFAULT_ENDPOINT    = 'http://brickset.com/api/v2.asmx'
+    DEFAULT_METHOD      = :get
+    DEFAULT_USER_AGENT  = "Brickset API Ruby Gem #{Brickset::VERSION}".freeze
+    DEFAULT_API_KEY     = ENV['BRICKSET_API_KEY']
+ 
+    # Build accessor methods for every config options so we can do this, for example:
+    #   Awesome.method = :get
+    attr_accessor *VALID_CONFIG_KEYS
+
+    # Make sure we have the default values set when we get 'extended'
+    def self.extended(base)
+      base.reset
+    end
+ 
+    def reset
+      self.endpoint   = DEFAULT_ENDPOINT
+      self.method     = DEFAULT_METHOD
+      self.user_agent = DEFAULT_USER_AGENT
+ 
+      self.api_key    = DEFAULT_API_KEY
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+  end
+end

data/lib/brickset/version.rb

@@ -0,0 +1,3 @@
+module Brickset
+  VERSION = "0.0.1"
+end

data/spec/brickset_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Brickset do
+  it 'should have a version number' do
+    expect(Brickset::VERSION).not_to be_nil
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Brickset::Client do
+
+  before do
+    @keys = Brickset::Configuration::VALID_CONFIG_KEYS
+  end
+
+  describe 'with module configuration' do
+    before do
+      Brickset.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      Brickset.reset
+    end
+
+    it "should inherit module configuration" do
+      api = Brickset::Client.new
+      @keys.each do |key|
+        expect(api.send(key)).to eq(key)
+      end
+    end
+
+    describe 'with class configuration' do
+      before do
+        @config = {
+          :api_key    => 'ak',
+          :endpoint   => 'ep',
+          :user_agent => 'ua',
+          :method     => 'hm',
+        }
+      end
+
+      it 'should override module configuration' do
+        api = Brickset::Client.new(@config)
+        @keys.each do |key|
+          expect(api.send(key)).to eq(@config[key])
+        end
+      end
+
+      it 'should override module configuration after' do
+        api = Brickset::Client.new
+
+        @config.each do |key, value|
+          api.send("#{key}=", value)
+        end
+
+        @keys.each do |key|
+          expect(api.send("#{key}")).to eq(@config[key])
+        end
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'configuration' do
+  after { Brickset.reset }
+
+  describe '.configure' do
+    Brickset::Configuration::VALID_CONFIG_KEYS.each do |key|
+      it "should set the #{key}" do 
+        Brickset.configure do |config|
+          config.send("#{key}=", key)
+          expect(Brickset.send(key)).to eq(key)
+        end
+      end
+    end
+  end
+
+  Brickset::Configuration::VALID_CONFIG_KEYS.each do |key|
+    describe ".#{key}" do
+      it 'should return the default value' do
+        expect(Brickset.send(key)).to eq(Brickset::Configuration.const_get("DEFAULT_#{key.upcase}"))
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'brickset'

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: brickset
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- dbwinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dbwinger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- brickset.gemspec
+- lib/brickset.rb
+- lib/brickset/client.rb
+- lib/brickset/configuration.rb
+- lib/brickset/version.rb
+- spec/brickset_spec.rb
+- spec/client_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Brickset.com v2 API
+test_files:
+- spec/brickset_spec.rb
+- spec/client_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb