omeka_client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe54ea6bb2500f310743cc83bf4c203356a0d25f
-  data.tar.gz: 8a8134364d70c54aaf0cf3e241ea97141f238da6
+  metadata.gz: 9ff4f2bddc2555b7645ff60265bf425785d5ea97
+  data.tar.gz: d6333149ed0684f15812558ca5941b57dc0a8bf8
 SHA512:
-  metadata.gz: 006f5a232c887a0084db1edfc9e83e44ce4551a786eb592a8b5075161a84650d31940450b2a85327f7af17dbb9409b6a06b146d6cd2e10db9c2e34aa5e7fc11f
-  data.tar.gz: f2a89cea37789f8acaaf7a82e22458861853f72fe33e625f5381f6c965fb1106c1dfa4ef4fa944959b6b7cdc669f0da8686a6850b488e352ada68d7a0253ffee
+  metadata.gz: b5c3269e51e86f0d63044227ad2de0e103691703733624246abd630bc7e5d971cc587db22f99ddc5b67292b6ab885029a1c9ddff8d6d30903381a0981df5b5f3
+  data.tar.gz: 7143ea1c58405c9c0ff7bd5a214da4004008b178e87ce67b9a3925e91a983c4f88cde103f17d2f6ed3e8e80ebea586bf4a88541a80eb3627a1f5134273f8dd38

data/README.md

@@ -1,4 +1,4 @@
-# OmekaClient
+# Omeka Client
 
 A REST client for [Omeka][], using the API introduced in Omeka 2.1.
 
@@ -28,10 +28,29 @@ First, load the gem in your script:
 
 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")
+    client = OmekaClient::Client.new("http://localhost/omeka/api", "api_key")
     # => #<OmekaClient::Client:0x007f4307937aa0>
 
-You can use the convenience methods for easy access to data.
+You can use the convenience methods for easy access to data. The most useful methods return classes that represent OmekaItems.
+
+    item = client.omeka_items(1)
+    item.id
+    # => 1
+    item.public
+    # => true
+    item.dublin_core.title
+    # => "Questions of the Soul"
+    item.dublin_core.author
+    # => "Hecker, Isaac Thomas, 1819-1888."
+    item.item_type
+    # => "book"
+    item.item_type_metadata.binding
+    # => "cloth"
+
+    item = client.omeka_items
+    # returns array of OmekaItem instances
+
+There are some helper methods to get other results in other forms:
 
     site_info = client.site
     puts site_info['title']
@@ -43,7 +62,7 @@ You can use the convenience methods for easy access to data.
     puts items[0]['url']
     # => http://localhost/omeka/api/items/1
 
-If you want more flexibility, you can use the higher level methods.
+If you want more flexibility about what you're requesting, you can use the lower-level methods.
 
     client.get('collections', 1)
 
@@ -61,7 +80,7 @@ You can generate the documentation by running `rake yard`.
 
 ## Future plans
 
-For now the gem only handles GET requests. I'm going to work on making methods that pull information out of Omeka as robust as possible before I deal with POST, PUT, and DELETE. Contributions are more than welcome.
+For now the gem only handles GET requests. I'm going to work on making methods that pull information out of Omeka as robust as possible before I deal with POST, PUT, and DELETE. In particular, the class representations of Omeka items are important. Contributions are more than welcome.
 
 ## License
 

data/lib/omeka_client.rb

@@ -2,12 +2,14 @@ require "rest"
 require "json"
 require "omeka_client/version"
 require "omeka_client/client"
+require "omeka_client/omeka-item"
 
 
 # 
 # The module wrapping the classes that do the work
 # 
 # @author Lincoln Mullen
+# @since  0.0.1
 # 
 module OmekaClient
 

data/lib/omeka_client/client.rb

@@ -35,6 +35,7 @@ module OmekaClient
     # @param  query [Hash] Additional query parameters
     # 
     # @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?
@@ -51,6 +52,7 @@ module OmekaClient
     #
     # @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
@@ -63,6 +65,31 @@ module OmekaClient
     # TODO: put
     # TODO: delete
 
+    # Methods that return 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.
+    # @param  query = {} [Hash] Additional query parameters 
+    # @since  0.0.2
+    # 
+    # @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)
+      end
+    end
+
     # Convenience methods
     # -------------------------------------------------------------------
 
@@ -74,8 +101,9 @@ module OmekaClient
     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
@@ -85,6 +113,7 @@ module OmekaClient
     # TODO: Check that items are available in the resources
     # 
     # @return [Array] Returns an array of item hashes
+    # @since 0.0.1
     def items
       self.get_hash('items')
     end
@@ -94,6 +123,7 @@ module OmekaClient
     # TODO: Check that items are available in the resources
     # 
     # @return [Array] Returns an array of collection hashes
+    # @since 0.0.1
     def collections
       self.get_hash('collections')
     end

data/lib/omeka_client/omeka-item.rb

@@ -0,0 +1,63 @@
+require "ostruct"
+
+module OmekaClient
+
+  # 
+  # A class to represent an item in an Omeka site
+  # 
+  # @author Lincoln Mullen
+  # @since  0.0.2
+  # 
+  class OmekaItem
+
+    # Instance variables for each of the main parts of the metadata
+    attr_accessor :id, :url, :public, :featured, :added, :modified, \
+    :item_type, :collection, :owner, :files, :tags, :dublin_core, \
+    :item_type_metadata, :extended_resources
+
+    # 
+    # Parse the data we got from the API into handy methods
+    # @param  hash [Hash] Uses the hash from OmekaClient::Client::get_hash
+    # 
+    def initialize(hash)
+
+      # Some of these values have strings. Others return arrays or hashes.
+      @id = hash['id']
+      @url = hash['url']
+      @public = hash['public']
+      @featured = hash['featured']
+      @added = hash['added']
+      @modified = hash['modified']
+      @item_type = hash['item_type']
+      @collection = hash['collection']
+      @owner = hash['owner']
+      @files = hash['files']
+      @tags = hash['tags']
+      @extended_resources = ['extended_resources']
+
+      # OpenStruct.new requires a hash of method names and methods values,
+      # which we construct here for Dublin Core and for the Item Type
+      # Metadata. The downside is that we are discarding some data.
+      # Element names become method names: "Lesson Plan" to "lesson_plan"
+      dc_metadata = Hash.new
+      item_metadata = Hash.new
+      hash['element_texts'].each do |e|
+        if e['element_set']['name'] == "Dublin Core"
+          method_name = e['element']['name'].downcase.gsub(/\s/, '_')
+          dc_metadata[method_name] = e['text']
+        elsif e['element_set']['name'] == "Item Type Metadata"
+          method_name = e['element']['name'].downcase.gsub(/\s/, '_')
+          item_metadata[method_name] = e['text']
+        end
+      end
+
+      # The OpenStruct will provide methods of the style
+      # item.dublin_core.title
+      @dublin_core = OpenStruct.new(dc_metadata)
+      @item_type_metadata = OpenStruct.new(item_metadata)
+
+    end
+
+  end
+
+end

data/lib/omeka_client/version.rb

@@ -1,4 +1,4 @@
 module OmekaClient
   # The version number
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/{omekaclient_test.rb → client_test.rb}

@@ -1,14 +1,14 @@
 require "minitest/autorun"
 require "omeka_client"
 
-# Set up an test client
-test_endpoint = "http://localhost/omeka-2.1-rc1/api"
-test_api_key = "c56c8f542bc98483b71896523d4faa6321de193b"
-resources = ["items", "collections"]
-client = OmekaClient::Client.new(test_endpoint, test_api_key)
-
 describe OmekaClient::Client do
 
+  # Setup a test client
+  test_endpoint = "http://localhost/omeka-2.1-rc1/api"
+  test_api_key = "c56c8f542bc98483b71896523d4faa6321de193b"
+  resources = ["items", "collections"]
+  client = OmekaClient::Client.new(test_endpoint, test_api_key)
+
   it "must have an endpoint" do
     client.endpoint.must_equal test_endpoint
   end
@@ -67,4 +67,16 @@ describe OmekaClient::Client do
     client.collections.wont_be_empty
   end
 
+  it "must return an OmekaItem class" do
+    puts client.omeka_items(1).must_be_instance_of OmekaClient::OmekaItem
+  end
+
+  it "must return an array of OmekaItem classes" do
+    puts client.omeka_items.must_be_instance_of Array
+    [0,1].each do |number|
+      puts client.omeka_items[number].must_be_instance_of \
+        OmekaClient::OmekaItem
+    end
+  end
+
 end

data/test/omeka-item_test.rb

@@ -0,0 +1,78 @@
+require "minitest/autorun"
+require "omeka_client"
+
+# Set up an test client
+test_endpoint = "http://localhost/omeka-2.1-rc1/api"
+test_api_key = "c56c8f542bc98483b71896523d4faa6321de193b"
+resources = ["items", "collections"]
+client = OmekaClient::Client.new(test_endpoint, test_api_key)
+# item_array = client.omeka_items
+item_single = client.omeka_items(1)
+
+
+describe OmekaClient::OmekaItem do
+
+  it "should have an ID" do
+    item_single.id.must_equal 1
+  end
+
+  it "should have a URL" do
+    item_single.url.must_be_instance_of String
+  end
+
+  it "should have a URL" do
+    item_single.url.must_be_instance_of String
+  end
+
+  it "should know whether it's public" do
+    item_single.public.wont_be_nil
+  end
+
+  it "should know whether it's featured" do
+    item_single.featured.wont_be_nil
+  end
+
+  it "should have a date added" do
+    item_single.added.must_be_instance_of String
+  end
+
+  it "should have a date modified" do
+    item_single.modified.must_be_instance_of String
+  end
+
+  it "should have an item type" do
+    item_single.item_type.must_be_instance_of Hash
+  end
+
+  it "should have a collection" do
+    item_single.collection.must_be_instance_of Hash
+  end
+
+  it "should have files" do
+    item_single.files.must_be_instance_of Hash
+  end
+
+  it "should have tags" do
+    item_single.tags.must_be_instance_of Array
+  end
+
+  it "should have extended resources" do
+    item_single.extended_resources.must_be_instance_of Array
+  end
+
+  it "should have the Dublin Core metadata" do
+    item_single.dublin_core.must_be_instance_of OpenStruct
+    dc_fields = [:title, :subject, :contributor, :description, :creator, \
+    :source, :publisher,  :date,  :rights, :relation, :format, :language, \
+    :type, :identifier, :coverage]
+    dc_fields.each do |field|
+      item_single.dublin_core.send(field).must_be_instance_of String
+    end
+  end
+
+  it "should have the Item Type metadata" do
+    item_single.item_type_metadata.must_be_instance_of OpenStruct
+    # The item type is unpredictable, so it's hard to be more specific
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omeka_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Lincoln Mullen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-13 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,9 +94,11 @@ files:
 - Rakefile
 - lib/omeka_client.rb
 - lib/omeka_client/client.rb
+- lib/omeka_client/omeka-item.rb
 - lib/omeka_client/version.rb
 - omeka_client.gemspec
-- test/omekaclient_test.rb
+- test/client_test.rb
+- test/omeka-item_test.rb
 homepage: https://github.com/lmullen/omeka_client
 licenses:
 - GPLv3
@@ -122,5 +124,6 @@ signing_key:
 specification_version: 4
 summary: A REST client to access the Omeka API
 test_files:
-- test/omekaclient_test.rb
+- test/client_test.rb
+- test/omeka-item_test.rb
 has_rdoc: