thewalters 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae269e1906ac9327a4f5bd6577f658e555c485ad
-  data.tar.gz: d7e620929b4b14dae693eace2a02ca4aebfc0395
+  metadata.gz: 9c3d6404eaed8587006923b7871440d9204b5722
+  data.tar.gz: 172f50a4c1f3e32ce904238113e92681cb0ff97d
 SHA512:
-  metadata.gz: 9da9ad04a2758fa7e17e942a365715d381071e06e8d8e7d5cc44511754a6a63f6c54de7aab2d3327dc1ec41f90361b432a695a7e7be6aa524ae86d3429de0a3b
-  data.tar.gz: 38762f5215aa5c187f8ff79f95975426b22e995b2fae65455cad42cef2e17c45b9999c95ee9b1cc8d1af30e1876c5ca66e9dc7b7252633becaf2183ff9cd5578
+  metadata.gz: ab50fcddd98c38f33a2c217d537243cd232e048aea9f2411303b4a456767a68ba202107eb1498e835f8c9c0902df0c6680454cca7638c7b3e0de00a0f4d23912
+  data.tar.gz: da8afe64874d3356527a6bb52f3c74be0ba9e25f16f1225c161f7f64643a1b3dcba6a12597974218cadc477d2c7e7ffbe5723b6c3fef8ee16e11ebba29ff70f0

data/README.rdoc

@@ -1,6 +1,6 @@
 = thewalters-ruby
 
-A Ruby gem for communicating with {The Walters API}[http://api.thewalters.org/help/index].
+A Ruby gem for communicating with {The Walters API}[http://api.thewalters.org/help/index]. {Documentation}[https://github.com/WaltersArtMuseum/walters-api]
 
 {<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]
@@ -33,9 +33,8 @@ This is a very immature project, and I need your help! The goal is to have a ful
 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
+* implement objects/:id/images with a first-class image object
 
 === 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.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.1

data/lib/thewalters/art_object.rb

@@ -1,7 +1,13 @@
 module TheWalters
-  # An ArtObject is known in the Walters API as an "Object"
+  # An ArtObject is a piece of art, an artifact or similar item within the
+  # Walters collections. It's known in the Walters API as an "Object".
   class ArtObject < Base
 
+    # Find a specific Object by id.
+    def self.find(id)
+      get_by_id(id)
+    end
+
     # Get the images for this object
     def images
       # TODO

data/lib/thewalters/base.rb

@@ -1,6 +1,14 @@
 module TheWalters
   # An error accessing the Walters API.
   class ApiError < StandardError; end
+  class NotFound < StandardError; end
+
+  def self.apikey=(apikey)
+    @apikey = apikey
+  end
+  def self.apikey
+    @apikey
+  end
 
   # A base objet for all endpoints.
   class Base < Hashie::Mash
@@ -10,25 +18,30 @@ module TheWalters
       get_all(params)
     end
 
-    # Find a specific item by id.
-    def self.find(id)
-      get_by_id(id)
-    end
-
     private
 
+    # Returns a Hash; "Items" contains the array of items.
     def self.get_all(params)
       path = [version, api_path].join("/")
-      objects = fetch(path, params)
-      objects.map {|o| self.new(o) }
+      result = fetch(path, params)
+      result["Items"] = result["Items"].map {|o| self.new(o) }
+      result
     end
 
     def self.get_by_id(id)
       path = [version, api_path, id].join("/")
-      object = fetch(path)
+      result = fetch(path)
+      object = result["Data"]
       self.new(object)
     end
 
+    def self.get_objects(id, params)
+      path = [version, api_path, id, 'objects'].join("/")
+      result = fetch(path, params)
+      result["Items"] = result["Items"].map {|o| ArtObject.new(o) }
+      result
+    end
+
     def self.version; "v1" end
     def self.base_url; "http://api.thewalters.org" end
     def self.path
@@ -38,7 +51,7 @@ module TheWalters
     def self.faraday
       Faraday.new(
         base_url,
-        headers: {user_agent: "walters-ruby (Faraday v#{Faraday::VERSION})"}
+        headers: {:user_agent => "walters-ruby (Faraday v#{Faraday::VERSION})", :accept => 'application/json'}
       ) do |faraday|
         # faraday.response :logger
         faraday.adapter Faraday.default_adapter
@@ -46,19 +59,27 @@ module TheWalters
     end
 
     def self.fetch(path, params={})
+      raise "You must first set your api key: try `TheWalters.apikey = '<mykey>'" if TheWalters.apikey.nil?
+      params = {:apikey => TheWalters.apikey}.merge(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
+      if response.success?
+        if response.headers['content-type'] =~ /json/
+          parsed = JSON.parse(response.body)
         else
-          details = ": #{parsed['Message'] || parsed['ReturnMessage']}"
-          # p parsed['ExceptionMessage']
-          raise ApiError.new("#{response.status}#{details}")
+          raise ApiError.new("Response is not JSON: #{response.body}")
         end
+      elsif response.status == 404
+        raise NotFound.new("This resource was not found: #{path}")
       else
-        raise ApiError.new("Response is not JSON: #{response.body}")
+        if response.headers['content-type'] =~ /json/
+          parsed = JSON.parse(response.body)
+          # p parsed['ExceptionMessage']
+          details = parsed['Message'] || parsed['ReturnMessage']
+        else
+          details = response.body
+        end
+        raise ApiError.new("#{response.status}: #{details}")
       end
     end
 

data/lib/thewalters/collection.rb

@@ -0,0 +1,15 @@
+module TheWalters
+  # A collection is a group of artworks, artifacts, or similar items within
+  # the Walters Art Museum. Collections at the Walters are grouped by
+  # primarily by culture and sometimes by date.
+  class Collection < Base
+
+    def objects(params)
+      TheWalters::Collection.get_objects(self.CollectionID, params)
+    end
+
+    private
+
+    def self.api_path; "collections" end
+  end
+end

data/lib/thewalters/exhibition.rb

@@ -0,0 +1,14 @@
+module TheWalters
+  # An exhibition is an organized presentation and display of a selection
+  # of museum objects.
+  class Exhibition < Base
+
+    def objects(params)
+      TheWalters::Exhibition.get_objects(self.ExhibitionID, params)
+    end
+
+    private
+
+    def self.api_path; "exhibitions" end
+  end
+end

data/lib/thewalters/geography.rb

@@ -0,0 +1,14 @@
+module TheWalters
+  # Geographies are locations on Earth where museum objects have been created
+  # or discovered, or locations that an object depicts or mentions.
+  class Geography < Base
+
+    def objects(params)
+      TheWalters::Geography.get_objects(self.GeographyID, params)
+    end
+
+    private
+
+    def self.api_path; "geographies" end
+  end
+end

data/lib/thewalters/location.rb

@@ -0,0 +1,15 @@
+module TheWalters
+  # Locations are locations within the Walters Art Museum where the various
+  # museum objects are on view. If an object is not on view, it will be
+  # associated with a 'not on view' location.
+  class Location < Base
+
+    def objects(params)
+      TheWalters::Location.get_objects(self.LocationID, params)
+    end
+
+    private
+
+    def self.api_path; "museum/locations" end
+  end
+end

data/lib/thewalters.rb

@@ -3,3 +3,7 @@ require 'hashie'
 require 'faraday'
 require 'thewalters/base'
 require 'thewalters/art_object'
+require 'thewalters/collection'
+require 'thewalters/geography'
+require 'thewalters/exhibition'
+require 'thewalters/location'

data/test/test_base.rb

@@ -2,17 +2,21 @@ require 'helper'
 
 class BaseTest < Test::Unit::TestCase
   class ExampleObject < TheWalters::Base
+    def self.find(id)
+      get_by_id(id)
+    end
     def self.api_path; "foo" end
   end
 
   def test_all_returns_objects
+    TheWalters.apikey = 'abc'
     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}]' ]}
+        stub.get('/v1/foo') {[ 200, {"content-type" => "application/json"}, '{"Items": [{"id": 1},{"id": 2},{"id": 3}]}' ]}
       end
     end
     ExampleObject.expects(:faraday).returns(test_faraday)
-    rows = ExampleObject.all
+    rows = ExampleObject.all["Items"]
     assert_equal 3, rows.size
     assert_equal ExampleObject, rows.first.class
     assert_equal 1, rows.first.id
@@ -20,13 +24,14 @@ class BaseTest < Test::Unit::TestCase
   end
 
   def test_all_with_params_returns_objects
+    TheWalters.apikey = 'abc'
     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}]' ]}
+        stub.get('/v1/foo') {[ 200, {"content-type" => "application/json"}, '{"Items": [{"id": 1},{"id": 2}]}' ]}
       end
     end
     ExampleObject.expects(:faraday).returns(test_faraday)
-    rows = ExampleObject.all(:pageSize => 2)
+    rows = ExampleObject.all(:pageSize => 2)["Items"]
     assert_equal 2, rows.size
     assert_equal ExampleObject, rows.first.class
     assert_equal 1, rows.first.id
@@ -34,9 +39,10 @@ class BaseTest < Test::Unit::TestCase
   end
 
   def test_find_returns_object
+    TheWalters.apikey = 'abc'
     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}' ]}
+        stub.get('/v1/foo/1') {[ 200, {"content-type" => "application/json"}, '{"Data": {"id": 1}}' ]}
       end
     end
     ExampleObject.expects(:faraday).returns(test_faraday)

data/thewalters.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: thewalters 0.2.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "thewalters"
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jonathan Julian"]
+  s.date = "2014-01-19"
+  s.description = "Easily get object metadata from The Walters API"
+  s.email = "jonathan@jonathanjulian.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.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",
+    "lib/thewalters/collection.rb",
+    "lib/thewalters/exhibition.rb",
+    "lib/thewalters/geography.rb",
+    "lib/thewalters/location.rb",
+    "test/helper.rb",
+    "test/test_base.rb",
+    "thewalters.gemspec"
+  ]
+  s.homepage = "http://github.com/WaltersArtMuseum/thewalters-ruby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.1.11"
+  s.summary = "A Ruby gem for communicating with The Walters API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hashie>, [">= 1.2.0"])
+      s.add_runtime_dependency(%q<faraday>, [">= 0.8.1"])
+      s.add_runtime_dependency(%q<json>, [">= 1.7.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<hashie>, [">= 1.2.0"])
+      s.add_dependency(%q<faraday>, [">= 0.8.1"])
+      s.add_dependency(%q<json>, [">= 1.7.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<hashie>, [">= 1.2.0"])
+    s.add_dependency(%q<faraday>, [">= 0.8.1"])
+    s.add_dependency(%q<json>, [">= 1.7.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thewalters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jonathan Julian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-01 00:00:00.000000000 Z
+date: 2014-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -128,8 +128,13 @@ files:
 - lib/thewalters.rb
 - lib/thewalters/art_object.rb
 - lib/thewalters/base.rb
+- lib/thewalters/collection.rb
+- lib/thewalters/exhibition.rb
+- lib/thewalters/geography.rb
+- lib/thewalters/location.rb
 - test/helper.rb
 - test/test_base.rb
+- thewalters.gemspec
 homepage: http://github.com/WaltersArtMuseum/thewalters-ruby
 licenses:
 - MIT