thewalters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae269e1906ac9327a4f5bd6577f658e555c485ad
+  data.tar.gz: d7e620929b4b14dae693eace2a02ca4aebfc0395
+SHA512:
+  metadata.gz: 9da9ad04a2758fa7e17e942a365715d381071e06e8d8e7d5cc44511754a6a63f6c54de7aab2d3327dc1ec41f90361b432a695a7e7be6aa524ae86d3429de0a3b
+  data.tar.gz: 38762f5215aa5c187f8ff79f95975426b22e995b2fae65455cad42cef2e17c45b9999c95ee9b1cc8d1af30e1876c5ca66e9dc7b7252633becaf2183ff9cd5578

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+#  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+#  - 2.1.0
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+# Add dependencies required to use your gem here.
+gem "hashie", ">= 1.2.0"
+gem "faraday", ">= 0.8.1"
+gem "json", ">= 1.7.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+  gem "mocha", :require => false
+end

data/Gemfile.lock

@@ -0,0 +1,60 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    metaclass (0.0.1)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  faraday (>= 0.8.1)
+  hashie (>= 1.2.0)
+  jeweler (~> 1.8.7)
+  json (>= 1.7.0)
+  mocha
+  rdoc (~> 3.12)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Jonathan Julian
+
+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.rdoc

@@ -0,0 +1,53 @@
+= thewalters-ruby
+
+A Ruby gem for communicating with {The Walters API}[http://api.thewalters.org/help/index].
+
+{<img src="https://travis-ci.org/WaltersArtMuseum/thewalters-ruby.png?branch=master" alt="Build Status" />}[https://travis-ci.org/WaltersArtMuseum/thewalters-ruby]
+{<img src="https://gemnasium.com/WaltersArtMuseum/thewalters-ruby.png" alt="Dependency Status" />}[https://gemnasium.com/WaltersArtMuseum/thewalters-ruby]
+
+== Install
+
+Via rubygems.org:
+
+  gem install thewalters
+
+Via bundler in a Gemfile:
+
+  gem "thewalters"
+
+== Accessing the REST API
+
+  require 'thewalters'
+
+  objects = TheWalters::ArtObject.all
+  object = TheWalters::ArtObject.find(objects.first.id)
+
++all+ returns an array of ruby objects, each object has all the API attributes on it. +find+ returns
+a single ruby object.
+
+See The Walters API at http://api.thewalters.org/help/index for up-to-date documentation.
+
+== Contributing to thewalters-ruby
+
+This is a very immature project, and I need your help! The goal is to have a fully-featured
+API client available for attendees of {ArtBytes 2014}[http://www.eventbrite.com/e/art-bytes-at-the-walters-tickets-9534980383].
+
+=== Things that need to be done
+* Add more endpoints
+* Implement parameter passing to the endpoints
+* Add more tests
+
+=== Do's and Don'ts
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Jonathan Julian. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "thewalters"
+  gem.homepage = "http://github.com/WaltersArtMuseum/thewalters-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby gem for communicating with The Walters API}
+  gem.description = %Q{Easily get object metadata from The Walters API}
+  gem.email = "jonathan@jonathanjulian.com"
+  gem.authors = ["Jonathan Julian"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "thewalters #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/thewalters/art_object.rb

@@ -0,0 +1,14 @@
+module TheWalters
+  # An ArtObject is known in the Walters API as an "Object"
+  class ArtObject < Base
+
+    # Get the images for this object
+    def images
+      # TODO
+    end
+
+    private
+
+    def self.api_path; "objects" end
+  end
+end

data/lib/thewalters/base.rb

@@ -0,0 +1,66 @@
+module TheWalters
+  # An error accessing the Walters API.
+  class ApiError < StandardError; end
+
+  # A base objet for all endpoints.
+  class Base < Hashie::Mash
+
+    # Get a list of all.
+    def self.all(params={})
+      get_all(params)
+    end
+
+    # Find a specific item by id.
+    def self.find(id)
+      get_by_id(id)
+    end
+
+    private
+
+    def self.get_all(params)
+      path = [version, api_path].join("/")
+      objects = fetch(path, params)
+      objects.map {|o| self.new(o) }
+    end
+
+    def self.get_by_id(id)
+      path = [version, api_path, id].join("/")
+      object = fetch(path)
+      self.new(object)
+    end
+
+    def self.version; "v1" end
+    def self.base_url; "http://api.thewalters.org" end
+    def self.path
+      raise "Path not defined for this class"
+    end
+
+    def self.faraday
+      Faraday.new(
+        base_url,
+        headers: {user_agent: "walters-ruby (Faraday v#{Faraday::VERSION})"}
+      ) do |faraday|
+        # faraday.response :logger
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def self.fetch(path, params={})
+      response = faraday.get(path, params)
+      # puts "body: #{response.body}"
+      if response.headers['content-type'] =~ /json/
+        parsed = JSON.parse(response.body)
+        if response.success?
+          parsed
+        else
+          details = ": #{parsed['Message'] || parsed['ReturnMessage']}"
+          # p parsed['ExceptionMessage']
+          raise ApiError.new("#{response.status}#{details}")
+        end
+      else
+        raise ApiError.new("Response is not JSON: #{response.body}")
+      end
+    end
+
+  end
+end

data/lib/thewalters-ruby.rb

@@ -0,0 +1 @@
+require 'thewalters'

data/lib/thewalters.rb

@@ -0,0 +1,5 @@
+require 'json'
+require 'hashie'
+require 'faraday'
+require 'thewalters/base'
+require 'thewalters/art_object'

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require "mocha/setup"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'thewalters'
+
+class Test::Unit::TestCase
+end

data/test/test_base.rb

@@ -0,0 +1,51 @@
+require 'helper'
+
+class BaseTest < Test::Unit::TestCase
+  class ExampleObject < TheWalters::Base
+    def self.api_path; "foo" end
+  end
+
+  def test_all_returns_objects
+    test_faraday = Faraday.new do |builder|
+      builder.adapter :test, Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get('/v1/foo') {[ 200, {"content-type" => "application/json"}, '[{"id": 1},{"id": 2},{"id": 3}]' ]}
+      end
+    end
+    ExampleObject.expects(:faraday).returns(test_faraday)
+    rows = ExampleObject.all
+    assert_equal 3, rows.size
+    assert_equal ExampleObject, rows.first.class
+    assert_equal 1, rows.first.id
+    assert_equal 3, rows.last.id
+  end
+
+  def test_all_with_params_returns_objects
+    test_faraday = Faraday.new do |builder|
+      builder.adapter :test, Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get('/v1/foo') {[ 200, {"content-type" => "application/json"}, '[{"id": 1},{"id": 2}]' ]}
+      end
+    end
+    ExampleObject.expects(:faraday).returns(test_faraday)
+    rows = ExampleObject.all(:pageSize => 2)
+    assert_equal 2, rows.size
+    assert_equal ExampleObject, rows.first.class
+    assert_equal 1, rows.first.id
+    assert_equal 2, rows.last.id
+  end
+
+  def test_find_returns_object
+    test_faraday = Faraday.new do |builder|
+      builder.adapter :test, Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get('/v1/foo/1') {[ 200, {"content-type" => "application/json"}, '{"id": 1}' ]}
+      end
+    end
+    ExampleObject.expects(:faraday).returns(test_faraday)
+    row = ExampleObject.find(1)
+    assert_equal ExampleObject, row.class
+    assert_equal 1, row.id
+  end
+end
+
+
+# Live error response
+# {"Data":null,"ReturnStatus":false,"ReturnCode":200,"ReturnMessage":["An error occurred while executing the command definition. See the inner exception for details."]

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: thewalters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Julian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+description: Easily get object metadata from The Walters API
+email: jonathan@jonathanjulian.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/thewalters-ruby.rb
+- lib/thewalters.rb
+- lib/thewalters/art_object.rb
+- lib/thewalters/base.rb
+- test/helper.rb
+- test/test_base.rb
+homepage: http://github.com/WaltersArtMuseum/thewalters-ruby
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for communicating with The Walters API
+test_files: []