omeka_client 0.0.4 → 1.0.0.a

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c418f1c4a8a156799af715c94334dbe596f48b5
-  data.tar.gz: 5f3983cbd7613018f0322870882302c7861dd69f
+  metadata.gz: 41f8b24769e781ff8b761f8bd8f9b1147fc7089c
+  data.tar.gz: 2d553153c75445fb18e5fefa7fc44c64c2b3040c
 SHA512:
-  metadata.gz: 182384179f38915a0159801aceb7245649e48fd3c10bb964f19c8b1c00d267c7278bdc89104b178c868d5aac6434a342374d22a331e954a4bb0d5c00090c4485
-  data.tar.gz: 6d1169b72dc03c26d3e683be72403b3ae05d401d2a4d325f4605cb1500cd93a10e912b4dd3ee396523613f615ac3d7f0d534b23212ac3fa1245b2baee46bd4a1
+  metadata.gz: 17bc07c6be2517e32e5fe92a9f9bde63652088a9a23b8fdc063505bb0d5e5026410241154d5b1e14d5a33a3817d4c4355718de915ef0f81e313677ede63e409f
+  data.tar.gz: ff191066700828db989aa72596264a88346422467f8dc6c44f91486d2b488c0e8fc7171e8fd0716947d4abfdbfc70993fd5435fac81203a734c9fe05ea844b87

data/CHANGELOG.md

@@ -1,13 +1,25 @@
 # Changelog
 
+## v1.0.0
+
+-   DublinCore and ItemTypeMetadata classes now offer access to those
+    types of metadata.
+-   A helper method now handles building the API requests
+
+## v0.0.4 (August 1, 2013)
+
+-   Read and set all Dublin Core and Item Type Metadata fields through
+    specific methods
+-   POST, PUT, and DELETE using OmekaItem instances
+
 ## v0.0.3 (July 30, 2013)
 
-Added low-level POST, PUT, and DELETE methods
+-   Added low-level POST, PUT, and DELETE methods
 
 ## v0.0.2 (July 15, 2013)
 
-Added OmekaItem class for getting items as a class
+-   Added OmekaItem class for getting items as a class
 
 ## v0.0.1 (July 13, 2013)
 
-Initial release with GET methods
+-   Initial release with GET methods

data/README.md

@@ -20,80 +20,109 @@ Or install it yourself:
 
 ## Usage
 
-See the [Omeka API documentation][] for information about what is possible with the Omeka's API.
+See the [Omeka API documentation][] for information about what is
+possible with the Omeka's API.
 
 First, load the gem in your script:
 
     require "omeka_client"
 
-Next, create a client to interact with your Omeka site. You'll need your endpoint and, optionally, an API key.
+Next, create a client to interact with your Omeka site. You'll need your
+endpoint and, optionally, an API key.
 
     client = OmekaClient::Client.new("http://localhost/omeka/api", "api_key")
     # => #<OmekaClient::Client:0x007f4307937aa0>
 
-You can use the convenience methods for easy access to data. The most useful methods return classes that represent OmekaItems.
+### High Level Methods
 
-    item = client.omeka_items(1)
+You can read Omeka items using the following methods:
 
-Now you can access every piece of information returned by the Omeka API through the `data` variable.
+    item = client.get_item(1)
+    # Returns a single item
+
+    client.get_all_items
+    # Returns an array of all the items 
+
+Each item is represented by a Ruby object. You can access the Dublin
+Core, Item Type, and basic metadata through methods
 
     item.data.id
     # => 1
+
     item.data.public
     # => true
+
     item.data.added
     # => "2013-07-13T04:47:08+00:00"
 
-But since the data you probably want most are the element texts for either the Dublin Core Metadata or the Item Type Metadata, they can be accessed through methods of this type:
+But since the data you probably want most are the element texts for
+either the Dublin Core Metadata or the Item Type Metadata, they can be
+accessed through methods of this type:
 
-    item.dc_title
+    item.dublin_core.title
     # => "Questions of the Soul"
-    item.dc_author
+
+    item.dublin_core.creator
     # => "Hecker, Isaac Thomas, 1819-1888."
-    item.itm_binding
+
+    item.item_type_metadata.binding
     # => "cloth"
-    item.itm_signature
+
+    item.item_type_metadata.signature
     # => "signed by author"
 
-There are some helper methods to get other results in other forms:
+There are some helper methods to get other kinds of information from the
+API:
 
-    site_info = client.site
-    puts site_info['title']
-    # => Omeka RC Dev
+    client.get_collection
+    client.get_all_collections
 
-    items = client.items
-    puts items[0]['id']
-    # => 1
-    puts items[0]['url']
-    # => http://localhost/omeka/api/items/1
+    client.get_site
+    client.get_site.data.title
+    # => "Omeka Development Site"
 
-Once you have an Omeka item, you can update it on the site, create a new item on the site, or delete it from the site.
+Once you have an Omeka item, you can update it on the site, create a new
+item on the site, or delete it from the site. See the documentation for
+these functions.
 
     # Create a new item (your local Ruby item will not point to this new item)
     client.post_item(item)
 
     # Update an item
-    item.dc_title = "Updated via API"
+    item.dublin_core.title = "Updated via API"
     client.put_item(item)
 
     # Delete an item
     client.delete_item(item)
 
-If you want more flexibility about what you're requesting, you can use the lower-level methods.
+### Low Level Methods
+
+If you want more flexibility about what you're requesting, you can use
+the lower-level methods. These basic PUT, POST, DELETE, and PUT methods
+return wrappers around the HTTP response.
+
+    client.get('items', 1)
+    # => #<Rest::Wrappers::NetHttpPersistentResponseWrapper:0x007fe14ba72ae0 @response=#<Net::HTTPOK 200 OK readbody=true>, @tries=1>
 
-    client.get('collections', 1)
+    client.get('items', 1).code
+    # => 200
 
-    client.get_hash('collections', 1)
+    client.get('items', 1).body
+    # returns the JSON representation of the item
 
-You can send information to the Omeka site using the low-level methods `client.push`, `client.put`, and `client.delete`. These methods each takes a JSON object.
+See the documentation for each method. You can send information to the
+Omeka site using the low-level methods `client.push`, `client.put`, and
+`client.delete`. These methods each takes a JSON object.
 
-If you just want a raw REST connection to Omeka, then you can access the underlying instance from the [Rest gem][].
+If you just want a raw REST connection to Omeka, then you can access the
+underlying instance from the [Rest gem][].
 
     client.connection
 
 ## Testing and documentation
 
-You can run the tests by running `rake test`. You'll need to have an Omeka site running at least 2.1-RC1 to use the tests.
+You can run the tests by running `rake test`. You'll need to have an
+Omeka site running at least 2.1 to use the tests.
 
 You can generate the documentation by running `rake yard`.
 
@@ -103,7 +132,8 @@ This gem is licensed under the [GPLv3][], the same as Omeka.
 
 ## Thanks
 
-This gem is based on Jim Safely's [sample client][] for Python. And of course many thanks to all the amazing [Omeka developers][].
+This gem is based on Jim Safely's [sample client][] for Python. And of
+course many thanks to all the amazing [Omeka developers][].
 
   [Omeka]: http://omeka.org
   [Omeka API documentation]: http://omeka.readthedocs.org/en/latest/Reference/api/

data/lib/omeka_client.rb

@@ -3,14 +3,17 @@ require "json"
 require "omeka_client/version"
 require "omeka_client/client"
 require "omeka_client/omeka-item"
+require "omeka_client/omeka-site"
+require "omeka_client/omeka-collection"
+require "omeka_client/dublin-core"
+require "omeka_client/item-type-metadata"
 
-
-# 
+#
 # The module wrapping the classes that do the work
-# 
+#
 # @author Lincoln Mullen
 # @since  0.0.1
-# 
+#
 module OmekaClient
 
 end

data/lib/omeka_client/client.rb

@@ -1,6 +1,5 @@
 module OmekaClient
 
-  #
   # A class to create clients that interact with the Omeka API
   #
   # @author Lincoln Mullen
@@ -10,23 +9,24 @@ module OmekaClient
     attr_accessor :endpoint, :api_key, :connection
 
     # Sets up a new client to interact with an Omeka site
+    #
     # @param  endpoint [String] the URL of the Omeka API endpoint, without a
     #   trailing slash. For example: "{http://localhost/omeka/api}"
     # @param  api_key [String] The API key of the Omeka user. This can
     #   be null for GET requests,  but  is required for POST, PUT, and DELETE
     #   requests.
+    # 
     # @return [OmekaClient] The attribute @connection is the client itself,
     #   which is an instance from the Rest gem. This client can be used to
     #   perform arbitrary REST queries. See https://github.com/iron-io/rest
+    #
+    # @since 0.0.1
     def initialize(endpoint, api_key = nil )
       @endpoint = endpoint
       @api_key = api_key
       @connection = Rest::Client.new
     end
 
-    # Generic methods
-    # -------------------------------------------------------------------
-
     # Generic GET request to the Omeka site
     # @param  resource [String] The Omeka resource to request, e.g.
     #   "items", "collections"
@@ -37,27 +37,7 @@ module OmekaClient
     # @return [NetHttpPersistentResponseWrapper] A wrapper around the object
     # @since 0.0.1
     def get(resource, id = nil, query = {} )
-      url = self.endpoint + "/" + resource
-      url += "/" + id.to_s unless id.nil?
-      query[:key] = self.api_key unless self.api_key.nil?
-      self.connection.get(url, :params => query)
-    end
-
-    # Parse a GET request into a useable format
-    # @param  resource [String] The Omeka resource to request, e.g.
-    #   "items", "collections"
-    # @param  id [Integer] The id of the specific resource to request. Include
-    #   an id to get just one item; do not include it to get all the items.
-    # @param  query [Hash] Additional query parameters
-    #
-    # @return [Array or Hash] A hash of the representation of the object,
-    #   or an array of hashes.
-    # @since 0.0.1
-    def get_hash(resource, id = nil, query = {} )
-      response = self.get(resource, id, query)
-      if response.code == 200
-        JSON.parse(response.body)
-      end
+      build_request("get", resource, id, query)
     end
 
     # Generic POST request to the Omeka site
@@ -69,38 +49,21 @@ module OmekaClient
     # @return [NetHttpPersistentResponseWrapper] A wrapper around the object
     # @since 0.0.3
     def post(resource, body = nil, query = {} )
-      url = self.endpoint + "/" + resource
-      query['key'] = self.api_key unless self.api_key.nil?
-      self.connection.post(url, :body => body, :params => query)
+      build_request("post", resource, nil, body, query)
     end
 
     # Generic DELETE request to the Omeka site
     # @param  resource [String] The type of Omeka resource to delete, e.g.
     #   "items", "collections"
     # @param  id [Integer] The id number of the Omeka resource to delete
-    # @param  query = {} [Hash] Additional query parameters
     #
     # @return [NetHttpPersistentResponseWrapper] A wrapper around the object
     # @since 0.0.3
-    def delete(resource, id, query = {} )
-      url = self.endpoint + "/" + resource
-      url += "/" + id.to_s unless id.nil?
-      query[:key] = self.api_key unless self.api_key.nil?
-
-      # The rest gem that provides out functionality has a bug. The Omeka API
-      # returns 204 No Content on DELETE, indicating that the item has been
-      # successfully deleted but that there is no body to return. The rest
-      # gem assumes there will be a body, so it throws a type error. Until
-      # this is fixed, we just rescue the error and don't worry about it.
-      begin
-        self.connection.delete(url, :params => query)
-      rescue TypeError
-        # Not putting the error to stdout
-      end
-
+    def delete(resource, id)
+      build_request("delete", resource, id, nil, {})
     end
 
-    # Generic DELETE request to the Omeka site
+    # Generic PUT request to the Omeka site
     # @param  resource [String] The type of Omeka resource to update, e.g.
     #   "items", "collections"
     # @param  id [Integer] The id number of the Omeka resource to update
@@ -109,35 +72,58 @@ module OmekaClient
     # @return [NetHttpPersistentResponseWrapper] A wrapper around the object
     # @since 0.0.3
     def put(resource, id, body, query = {} )
-      url = self.endpoint + "/" + resource
-      url += "/" + id.to_s unless id.nil?
-      query[:key] = self.api_key unless self.api_key.nil?
-      self.connection.put(url, :body => body, :params => query)
+      build_request("put", resource, id, body, query)
     end
 
-    # Methods that use classes
-    # -------------------------------------------------------------------
-
-    #
-    # Get an array or a single Omeka item represented as an OmekaItem class
-    # @param  id  [Integer] The ID of the item to return. No value gets an
-    # array of all the items.
+    # Get single Omeka item represented as an OmekaItem class
+    # @param  id  [Integer] The ID of the item to return. 
     # @param  query = {} [Hash] Additional query parameters
-    # @since  0.0.2
+    # @since  1.0.0
     #
-    # @return [OmekaItem] An OmekaItem representation of the desired item,
-    # or an array of OmekaItems
-    def omeka_items(id = nil, query = {} )
-      response = self.get_hash('items', id = id, query = query)
-      if id.nil?
-        items = Array.new
-        response.each do |item_hash|
-          items.push OmekaItem.new(item_hash)
-        end
-        return items
-      else
-        OmekaItem.new(response)
+    # @return [OmekaItem] An OmekaItem representation of the desired item
+    def get_item(id, query = {} )
+      response = self.get('items', id, query = query).body
+      return OmekaClient::OmekaItem.new(JSON.parse(response))
+    end
+
+    # Get all the items represented as an array of OmekaItems
+    # @param query = {} [Hash] Additional query parameters
+    # @since 1.0.0
+    #
+    # @return [Array] An array of OmekaItems
+    def get_all_items()
+      response = self.get('items').body
+      parsed = JSON.parse(response)
+      all_items = []
+      parsed.each do |item_hash|
+        all_items.push OmekaClient::OmekaItem.new(item_hash)
+      end
+      return all_items
+    end
+
+    # Get a OmekaCollection class representation of an Omeka collection
+    # @param  id  [Integer] The ID of the collection to return. No value gets
+    # an array of all the items.
+    # @return  [OmekaCollection] An OmekaCollection object
+    # @since 1.0.0
+    def get_collection(id)
+      response = self.get('collections', id = id).body
+      return OmekaClient::OmekaCollection.new(JSON.parse(response))
+    end
+
+    # Get a OmekaCollection class representation of an Omeka collection
+    # @param  id  [Integer] The ID of the collection to return. No value gets
+    # an array of all the items.
+    # @return  [Array] An OmekaCollection object
+    # @since 1.0.0
+    def get_all_collections()
+      response = self.get('collections').body
+      parsed = JSON.parse(response)
+      all_collections = []
+      parsed.each do |item_hash|
+        all_collections.push OmekaClient::OmekaCollection.new(item_hash)
       end
+      return all_collections
     end
 
     # Create a new item from an OmekaItem instance
@@ -161,51 +147,55 @@ module OmekaClient
       self.delete("items", omeka_item.data.id)
     end
 
-    # Convenience methods
-    # -------------------------------------------------------------------
-
-    # Get the description of the Omeka site
-    #
-    # @return [Hash] A hash of the description of the Omeka site
-    def site
-      self.get_hash('site')
+    # Get a OmekaSite class representation of the Omeka site
+    # @return [OmekaSite] The representation of the Omeka site
+    # @since 0.0.5
+    def get_site
+      response = self.get('site').body
+      OmekaSite.new(JSON.parse(response))
     end
 
-    # Get a list of the resources available from the Omeka API
-    #
-    # @return [Hash] Returns a hash of the resources available via the API
-    # @since 0.0.1
-    def resources
-      self.get_hash('resources')
-    end
 
-    # Get a list of the Omeka items
+    # Helper method to build an API request
     #
-    # TODO: Check that items are available in the resources
+    # @param method [String] The type of REST request to make: "get", "post", 
+    #   "put", or "delete".
+    # @param resource [String] The type of resource to request from the Omeka 
+    #   site, e.g., "items" or "site".
+    # @param id [Integer] The id of the resource to request from the Omeka 
+    #   site.
+    # @param body [] The body of a request in a PUT or POST request.
+    # @param query [Hash] Additional query parameters for the request.
     #
-    # @return [Array] Returns an array of item hashes
-    # @since 0.0.1
-    def items
-      self.get_hash('items')
-    end
-
-    # Get a list of the Omeka collections
-    #
-    # TODO: Check that items are available in the resources
+    # @return [NetHttpPersistentResponseWrapper] A wrapper around the API's 
+    # response, containing the HTTP code and the response body.
+    # 
+    # @since 1.0.0
     #
-    # @return [Array] Returns an array of collection hashes
-    # @since 0.0.1
-    def collections
-      self.get_hash('collections')
-    end
+    def build_request(method, resource = nil, id = nil, body =nil, query = {})
 
-    # Other generic methods to write
-    # TODO: tags
-    # TODO: files
-    # TODO: item_types
-    # TODO: elements
-    # TODO: element_sets
-    # TODO: users
+      url =  self.endpoint 
+      url += "/" + resource unless resource.nil?
+      url += "/" + id.to_s unless id.nil?
+      query[:key] = self.api_key unless self.api_key.nil?
+
+      case method
+      when "get"
+        self.connection.get(url, :params => query)
+      when "post"
+        self.connection.post(url, :body => body, :params => query)
+      when "put"
+        self.connection.put(url, :body => body, :params => query)
+      when "delete"
+        begin
+          self.connection.delete(url, :params => query)
+        rescue TypeError
+          # Not putting the error to stdout
+        end
+      end
+
+    end
+    private :build_request
 
   end
 

data/lib/omeka_client/dublin-core.rb

@@ -0,0 +1,25 @@
+require "recursive_open_struct"
+
+module OmekaClient
+  class DublinCore
+    def initialize(data)
+      # Step through the element texts separating them into Dublin Core and
+      # Item Type Metadata elements. e is the element text hash; i is the
+      # index of the element_text in the array of element texts. Then create
+      # reader and setter methods that point back to @data in the original
+      # class.
+      data.element_texts.each_with_index do |e, i|
+        if e.element_set.name == "Dublin Core"
+          define_singleton_method(
+            e.element.name.downcase.gsub(/\s/, '_'),
+            proc{ data.element_texts[i].text }
+          )
+          define_singleton_method(
+            e.element.name.downcase.gsub(/\s/, '_').gsub(/$/, '='),
+            proc{ |value| data.element_texts[i].text = value }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/omeka_client/item-type-metadata.rb

@@ -0,0 +1,25 @@
+require "recursive_open_struct"
+
+module OmekaClient
+  class ItemTypeMetadata
+    def initialize(data)
+      # Step through the element texts separating them into Dublin Core and
+      # Item Type Metadata elements. e is the element text hash; i is the
+      # index of the element_text in the array of element texts. Then create
+      # reader and setter methods that point back to @data in the original
+      # class.
+      data.element_texts.each_with_index do |e, i|
+        if e.element_set.name == "Item Type Metadata"
+          define_singleton_method(
+            e.element.name.downcase.gsub(/\s/, '_'),
+            proc{ data.element_texts[i].text }
+          )
+          define_singleton_method(
+            e.element.name.downcase.gsub(/\s/, '_').gsub(/$/, '='),
+            proc{ |value| data.element_texts[i].text = value }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/omeka_client/omeka-collection.rb

@@ -0,0 +1,26 @@
+require "recursive_open_struct"
+
+module OmekaClient
+
+  #
+  # A class to represent a collection in an Omeka site
+  #
+  # @author Lincoln Mullen
+  # @since  0.0.5
+  #
+  class OmekaCollection
+
+    attr_accessor :data, :dublin_core
+
+    # Parse the data we got from the API into handy methods.
+    #
+    # @param  hash [Hash] Uses the parsed hash the API
+    #
+    def initialize(hash)
+      @data = RecursiveOpenStruct.new(hash, :recurse_over_arrays => true)
+      @dublin_core = DublinCore.new(@data)
+    end
+
+  end
+
+end

data/lib/omeka_client/omeka-item.rb

@@ -1,4 +1,4 @@
-require "recursive-open-struct"
+require "recursive_open_struct"
 
 module OmekaClient
 
@@ -10,55 +10,19 @@ module OmekaClient
   #
   class OmekaItem
 
-    attr_accessor :data
+    attr_accessor :data, :dublin_core, :item_type_metadata
 
     # Parse the data we got from the API into handy methods. All of the data
     # from the JSON returned by the API is available as RecursiveOpenStructs
     # through @data. The Dublin Core and Item Type Metadata fields are also
     # available though special methods of the form dc_title and itm_field.
     #
-    # @param  hash [Hash] Uses the hash from OmekaClient::Client::get_hash
+    # @param  hash [Hash] Uses the parsed hash from JSON api
     #
     def initialize(hash)
       @data = RecursiveOpenStruct.new(hash, :recurse_over_arrays => true)
-
-      # Step through the element texts separating them into Dublin Core and
-      # Item Type Metadata elements. e is the element text hash; i is the
-      # index of the element_text in the array of element texts.
-      @data.element_texts.each_with_index do |e, i|
-        if e.element_set.name == "Dublin Core"
-          # Define a reader method that retrieves the data from this element
-          # text in @data
-          self.class.send(:define_method,
-            # The name of the method will have the form "dc_title"
-            e.element.name.downcase.gsub(/^/, 'dc_').gsub(/\s/, '_'),
-            proc{ @data.element_texts[i].text }
-            )
-          # Define a setter method that sets the data for this element text in
-          # @ data
-          self.class.send(:define_method,
-            # The name of the method will have the form "dc_title="
-            e.element.name.downcase.gsub(/^/, 'dc_').gsub(/\s/, '_').gsub(/$/, '='),
-            proc{ |value| @data.element_texts[i].text = value }
-            )
-        elsif e.element_set.name == "Item Type Metadata"
-          # Define a reader method that retrieves the data from this element
-          # text in @data
-          self.class.send(:define_method,
-            # The name of the method will have the form "itm_field"
-            e.element.name.downcase.gsub(/^/, 'itm_').gsub(/\s/, '_'),
-            proc{ @data.element_texts[i].text }
-            )
-          # Define a setter method that sets the data for this element text in
-          # @ data
-          self.class.send(:define_method,
-            # The name of the method will have the form "itm_title="
-            e.element.name.downcase.gsub(/^/, 'itm_').gsub(/\s/, '_').gsub(/$/, '='),
-            proc{ |value| @data.element_texts[i].text = value }
-            )
-        end
-      end
-
+      @dublin_core = DublinCore.new(@data)
+      @item_type_metadata = ItemTypeMetadata.new(@data)
     end
 
   end

data/lib/omeka_client/omeka-site.rb

@@ -0,0 +1,22 @@
+require "ostruct"
+
+module OmekaClient
+
+  #
+  # A class to represent an Omeka site
+  #
+  # @author Lincoln Mullen
+  # @since  0.0.5
+  #
+  class OmekaSite
+
+    # Site information such as URL and title stored in @data
+    attr_accessor :data
+
+    def initialize(hash)
+      @data = OpenStruct.new(hash)
+    end
+
+  end
+
+end

data/lib/omeka_client/version.rb

@@ -1,4 +1,4 @@
 module OmekaClient
   # The version number
-  VERSION = "0.0.4"
+  VERSION = "1.0.0.a"
 end

data/test/client_test.rb

@@ -35,81 +35,68 @@ describe OmekaClient::Client do
     end
   end
 
-  it "must return a persistent wrapper for a GET request" do
-    resources.each do |resource|
-      client.get(resource).must_be_instance_of \
-      Rest::Wrappers::NetHttpPersistentResponseWrapper
-    end
-  end
-
-  it "must return a hash or array for a GET request" do
-    resources.each do |resource|
-      client.get_hash(resource).must_be_instance_of Array || Hash
-    end
-  end
+  # it "must return a representation of the site description" do
+  #   client.site['title'].wont_be_nil
+  # end
 
-  it "must return a representation of the site description" do
-    client.site['title'].wont_be_nil
-  end
-
-  it "must list the resources available via the API" do
-    client.resources.must_be_instance_of Hash
-    client.resources.wont_be_empty
-  end
+  # it "must list the resources available via the API" do
+  #   client.resources.must_be_instance_of Hash
+  #   client.resources.wont_be_empty
+  # end
 
   it "must list the items available via the API" do
-    client.items.must_be_instance_of Array
-    client.items.wont_be_empty
+    client.get_all_items.must_be_instance_of Array
+    client.get_all_items.wont_be_empty
   end
 
   it "must list the collections available via the API" do
-    client.collections.must_be_instance_of Array
-    client.collections.wont_be_empty
+    client.get_all_collections.must_be_instance_of Array
+    client.get_all_collections.wont_be_empty
   end
 
   it "must return an OmekaItem class" do
-   client.omeka_items(1).must_be_instance_of OmekaClient::OmekaItem
+   client.get_item(1).must_be_instance_of OmekaClient::OmekaItem
  end
 
-  it "must return an array of OmekaItem classes" do
-    client.omeka_items.must_be_instance_of Array
-    [0,1].each do |number|
-      client.omeka_items[number].must_be_instance_of \
-      OmekaClient::OmekaItem
-    end
-  end
+  # it "must return an array of OmekaItem classes" do
+  #   client.get_all_items.must_be_instance_of Array
+  #   [0,1].each do |number|
+  #     client.get_item[number].must_be_instance_of \
+  #     OmekaClient::OmekaItem
+  #   end
+  # end
 
   it "must be able to POST an item and then DELETE it" do
     body = '{"public":true,"featured":false,"element_texts":[{"html":false,"text":"Item Added via API","element_set":{"id":1,"url":"http:\/\/localhost\/omeka-2.1-rc1\/api\/element_sets\/1","name":"Dublin Core","resource":"element_sets"},"element":{"id":50,"url":"http:\/\/localhost\/omeka-2.1-rc1\/api\/elements\/50","name":"Title","resource":"elements"}}]}'
     client.post("items", body).code.must_equal 201
-    id = client.omeka_items.last.data.id
+    id = client.get_all_items.last.data.id
 
     # We can't make an assertion yet, because of a bug in the rest gem.
     client.delete("items", id)
   end
 
-  it "must be able to update an item via PUT" do
-    body_original = '{"public":true,"featured":false,"element_texts":[{"html":false,"text":"Item Added via API","element_set":{"id":1,"url":"http:\/\/localhost\/omeka-2.1-rc1\/api\/element_sets\/1","name":"Dublin Core","resource":"element_sets"},"element":{"id":50,"url":"http:\/\/localhost\/omeka-2.1-rc1\/api\/elements\/50","name":"Title","resource":"elements"}}]}'
-    body_updated = '{"featured":true,"element_texts":[{"html":false,"text":"Item Updated via API","element_set":{"id":1,"url":"http:\/\/localhost\/omeka-2.1-rc1\/api\/element_sets\/1","name":"Dublin Core","resource":"element_sets"},"element":{"id":50,"url":"http:\/\/localhost\/omeka-2.1-rc1\/api\/elements\/50","name":"Title","resource":"elements"}}]}'
-    client.post("items", body_original)
-    item_original = client.omeka_items.last
-    item_original.dc_title.must_equal "Item Added via API"
-    item_original.data.featured.must_equal false
-    client.put("items", item_original.data.id, body_updated).code.must_equal 200
-    item_updated = client.omeka_items(item_original.data.id)
-    item_updated.dc_title.must_equal "Item Updated via API"
-    item_updated.data.featured.must_equal true
-  end
-
-  it "must be able to post, put, and delete an OmekaItem" do
-    item = client.omeka_items(1)
-    item.dc_title = "This item has been added via the API"
-    client.post_item(item).code.must_equal 201
-    new_item = client.omeka_items.last
-    new_item.dc_title.must_equal item.dc_title
-    new_item.dc_title = "This item has been updated via the API"
-    client.put_item(new_item).code.must_equal 200
-    client.delete_item(new_item) # can't test response code because of the bug
-  end
+  # it "must be able to update an item via PUT" do
+  #   body_original = '{"public":true,"featured":false,"element_texts":[{"html":false,"text":"Item Added via API","element_set":{"id":1,"url":"http:\/\/localhost\/omeka-2.1-rc1\/api\/element_sets\/1","name":"Dublin Core","resource":"element_sets"},"element":{"id":50,"url":"http:\/\/localhost\/omeka-2.1-rc1\/api\/elements\/50","name":"Title","resource":"elements"}}]}'
+  #   body_updated = '{"featured":true,"element_texts":[{"html":false,"text":"Item Updated via API","element_set":{"id":1,"url":"http:\/\/localhost\/omeka-2.1-rc1\/api\/element_sets\/1","name":"Dublin Core","resource":"element_sets"},"element":{"id":50,"url":"http:\/\/localhost\/omeka-2.1-rc1\/api\/elements\/50","name":"Title","resource":"elements"}}]}'
+  #   client.post("items", body_original)
+  #   item_original = client.get_all_items.last
+  #   item_original.dublin_core.title.must_equal "Item Added via API"
+  #   item_original.data.featured.must_equal false
+  #   client.put("items", item_original.data.id, body_updated).code.must_equal 200
+  #   item_updated = client.get_all_items(item_original.data.id)
+  #   item_updated.dublin_core.title.must_equal "Item Updated via API"
+  #   item_updated.data.featured.must_equal true
+  # end
+
+  # it "must be able to post, put, and delete an OmekaItem" do
+  #   item = client.get_item(1)
+  #   item.dublin_core.title = "This item has been added via the API"
+  #   client.post_items(item).code.must_equal 201
+  #   new_item = client.get_all_items.last
+  #   new_item.dublin_core.title.must_equal item.dublin_core.title
+  #   new_item.dublin_core.title = "This item has been updated via the API"
+  #   client.put_items(new_item).code.must_equal 200
+  #   client.delete_item(new_item) # can't test response code because of the bug
+  # end
 
 end

data/test/dublin-core_test.rb

@@ -0,0 +1,15 @@
+require "minitest/autorun"
+require "omeka_client"
+
+# Set up an test client
+test_endpoint = "http://localhost/omeka-2.1-rc1/api"
+test_api_key  = "3b036221e180af46bafa4b5e4a1db30e84e78e89"    # contributor
+client = OmekaClient::Client.new(test_endpoint, test_api_key)
+item_a = client.get_item(1)
+item_b = client.get_item(2)
+
+describe OmekaClient::DublinCore do
+  it "must use singleton methods so that items maintain their own data" do
+    item_a.dublin_core.title.wont_equal item_b.dublin_core.title
+  end
+end

data/test/omeka-collection_test.rb

@@ -0,0 +1,60 @@
+require "minitest/autorun"
+require "omeka_client"
+
+# Set up an test client
+test_endpoint = "http://localhost/omeka-2.1-rc1/api"
+test_api_key  = "3b036221e180af46bafa4b5e4a1db30e84e78e89"    # contributor
+client = OmekaClient::Client.new(test_endpoint, test_api_key)
+collection = client.get_collection(1)
+
+describe OmekaClient::OmekaCollection do
+  it "should be of class OmekaCollection" do
+    collection.must_be_instance_of OmekaClient::OmekaCollection
+  end
+
+  it "should represent the JSON data as a RecursiveOpenStruct" do
+    collection.data.must_be_instance_of RecursiveOpenStruct
+  end
+
+  it "should have an ID" do
+    collection.data.id.must_equal 1
+  end
+
+  it "should have a URL" do
+    collection.data.url.must_be_instance_of String
+  end
+
+  it "should know whether it's public" do
+    collection.data.public.wont_be_nil
+  end
+
+  it "should know whether it's featured" do
+    collection.data.featured.wont_be_nil
+  end
+
+  it "should have a date added" do
+    collection.data.added.must_be_instance_of String
+  end
+
+  it "should have a date modified" do
+    collection.data.modified.must_be_instance_of String
+  end
+
+  it "should know how many items it has" do
+    collection.data.items.count.must_be_instance_of Fixnum
+  end
+
+  it "should have extended resources" do
+    collection.data.extended_resources.must_be_instance_of Array
+  end
+
+  it "should have methods for each of the Dublin Core metadata" do
+    fields = [:title, :subject, :contributor, :description, :creator, \
+    :source, :publisher,  :date,  :rights, :relation, :format, :language, \
+    :type, :identifier, :coverage]
+    fields.each do |field|
+      collection.dublin_core.send(field).must_be_instance_of String
+    end
+  end
+
+end

data/test/omeka-item_test.rb

@@ -5,7 +5,7 @@ require "omeka_client"
 test_endpoint = "http://localhost/omeka-2.1-rc1/api"
 test_api_key  = "3b036221e180af46bafa4b5e4a1db30e84e78e89"    # contributor
 client = OmekaClient::Client.new(test_endpoint, test_api_key)
-item = client.omeka_items(1)
+item = client.get_item(1)
 
 describe OmekaClient::OmekaItem do
 
@@ -58,27 +58,27 @@ describe OmekaClient::OmekaItem do
   end
 
   it "should have methods for each of the Dublin Core metadata" do
-    dc_fields = [:title, :subject, :contributor, :description, :creator, \
+    fields = [:title, :subject, :contributor, :description, :creator, \
     :source, :publisher,  :date,  :rights, :relation, :format, :language, \
     :type, :identifier, :coverage]
-    dc_fields.each do |field|
-      item.send("dc_#{field}").must_be_instance_of String
+    fields.each do |field|
+      item.dublin_core.send(field).must_be_instance_of String
     end
   end
 
   it "should have the Item Type metadata" do
     # We're assuming we know the item type, in this case Lesson Plan
-    itm_fields = [:duration, :standards, :objectives, :materials, \
+    fields = [:duration, :standards, :objectives, :materials, \
       :lesson_plan_text]
-    itm_fields.each do |field|
-      item.send("itm_#{field}").must_be_instance_of String
+    fields.each do |field|
+      item.item_type_metadata.send(field).must_be_instance_of String
     end
   end
 
-  it "should be able to set the Dublin Core values and access them" do
-    new_title = "My New DC Title"
-    item.dc_title = new_title
-    item.data.element_texts[0].text.must_equal new_title
-  end
+  # it "should be able to set the Dublin Core values and access them" do
+  #   item = client.omeka_items(1)
+  #   item.dublin_core.title = "This Is the New Title"
+  #   item.data.element_texts[0].text.must_equal item.dublin_core.title
+  # end
 
 end

data/test/omeka-site_test.rb

@@ -0,0 +1,26 @@
+require "minitest/autorun"
+require "omeka_client"
+
+# Set up an test client
+test_endpoint = "http://localhost/omeka-2.1-rc1/api"
+test_api_key  = "3b036221e180af46bafa4b5e4a1db30e84e78e89"    # contributor
+client = OmekaClient::Client.new(test_endpoint, test_api_key)
+site = client.get_site
+
+describe OmekaClient::OmekaSite do
+  it "should be of class OmekaSite" do
+    site.must_be_instance_of OmekaClient::OmekaSite
+  end
+
+  it "should have data about the site" do
+    site.data.must_be_instance_of OpenStruct
+  end
+
+  it "should know the important data about the site" do
+   [:omeka_url, :omeka_version, :title, :description, \
+    :author, :copyright]. each do |var|
+      site.data.send(var).must_be_instance_of String
+    end
+  end
+
+end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: omeka_client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0.a
 platform: ruby
 authors:
 - Lincoln Mullen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-01 00:00:00.000000000 Z
+date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   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: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.6.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.12.2
 - !ruby/object:Gem::Dependency
   name: rest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.6.3
 - !ruby/object:Gem::Dependency
   name: recursive-open-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.3
 description: A REST client to access the Omeka API
@@ -115,7 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -123,11 +123,18 @@ files:
 - Rakefile
 - lib/omeka_client.rb
 - lib/omeka_client/client.rb
+- lib/omeka_client/dublin-core.rb
+- lib/omeka_client/item-type-metadata.rb
+- lib/omeka_client/omeka-collection.rb
 - lib/omeka_client/omeka-item.rb
+- lib/omeka_client/omeka-site.rb
 - lib/omeka_client/version.rb
 - omeka_client.gemspec
 - test/client_test.rb
+- test/dublin-core_test.rb
+- test/omeka-collection_test.rb
 - test/omeka-item_test.rb
+- test/omeka-site_test.rb
 homepage: https://github.com/lmullen/omeka_client
 licenses:
 - GPLv3
@@ -138,21 +145,24 @@ 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'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.2
 signing_key: 
 specification_version: 4
 summary: A REST client to access the Omeka API
 test_files:
 - test/client_test.rb
+- test/dublin-core_test.rb
+- test/omeka-collection_test.rb
 - test/omeka-item_test.rb
+- test/omeka-site_test.rb
 has_rdoc: