omeka_client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ff4f2bddc2555b7645ff60265bf425785d5ea97
-  data.tar.gz: d6333149ed0684f15812558ca5941b57dc0a8bf8
+  metadata.gz: ad08751ec7991ecc76863bf3f80e24e82e5a34f9
+  data.tar.gz: 65f8d081ee86f044ba6a8da39606a18395da6488
 SHA512:
-  metadata.gz: b5c3269e51e86f0d63044227ad2de0e103691703733624246abd630bc7e5d971cc587db22f99ddc5b67292b6ab885029a1c9ddff8d6d30903381a0981df5b5f3
-  data.tar.gz: 7143ea1c58405c9c0ff7bd5a214da4004008b178e87ce67b9a3925e91a983c4f88cde103f17d2f6ed3e8e80ebea586bf4a88541a80eb3627a1f5134273f8dd38
+  metadata.gz: 836c522e5ffe3984195df0b833ca1a8df3a6f18f7f2f04e184759839e846fffac0c6915b378ce56812bdaa044b6efb242fbec99cbb4b77d94c2d85b66fb724c2
+  data.tar.gz: 877faf52eb48ef0d1cec2765c6c254597c7634c2f13d806602357b8e27abceb0db117e76f524a87288007d79838a488fb1ee5b98019cae93c421fd6fb00b3604

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## v0.0.3 (July 30, 2013)
+
+Added low-level POST, PUT, and DELETE methods
+
+## v0.0.2 (July 15, 2013)
+
+Added OmekaItem class for getting items as a class
+
+## v0.0.1 (July 13, 2013)
+
+Initial release with GET methods

data/lib/omeka_client/client.rb

@@ -60,10 +60,60 @@ module OmekaClient
       end
     end
 
-    # Other generic methods to write
-    # TODO: post
-    # TODO: put
-    # TODO: delete
+    # Generic POST request to the Omeka site
+    # @param  resource [String] The Omeka resource to request, e.g.
+    #   "items", "collections"
+    # @param  body [String] A string containing a JSON representation of the body of the item
+    # @param  query = {} [Hash] Additional query parameters (optional)
+    # 
+    # @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)
+    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
+
+    end
+
+    # Generic DELETE 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
+    # @param  query = {} [Hash] Additional query parameters
+    # 
+    # @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)
+    end
 
     # Methods that return classes
     # -------------------------------------------------------------------

data/lib/omeka_client/version.rb

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

data/omeka_client.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.1.0"
   spec.add_development_dependency "minitest"
-  spec.add_development_dependency "yard"
+  spec.add_development_dependency "yard", "~> 0.8.6.2"
 
   spec.add_dependency "rest", "~> 2.6.3"
 end

data/test/client_test.rb

@@ -5,9 +5,9 @@ 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)
+  test_api_key  = "3b036221e180af46bafa4b5e4a1db30e84e78e89"    # contributor
+  resources     = ["items", "collections"]
+  client        = OmekaClient::Client.new(test_endpoint, test_api_key)
 
   it "must have an endpoint" do
     client.endpoint.must_equal test_endpoint
@@ -68,15 +68,37 @@ describe OmekaClient::Client do
   end
 
   it "must return an OmekaItem class" do
-    puts client.omeka_items(1).must_be_instance_of OmekaClient::OmekaItem
-  end
+   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
+    client.omeka_items.must_be_instance_of Array
     [0,1].each do |number|
-      puts client.omeka_items[number].must_be_instance_of \
-        OmekaClient::OmekaItem
+      client.omeka_items[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.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.dublin_core.title.must_equal "Item Added via API"
+    item_original.featured.must_equal false
+    client.put("items", item_original.id, body_updated).code.must_equal 200
+    item_updated = client.omeka_items(item_original.id)
+    item_updated.dublin_core.title.must_equal "Item Updated via API"
+    item_updated.featured.must_equal true
+  end
+
 end

data/test/omeka-item_test.rb

@@ -4,7 +4,6 @@ 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omeka_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Lincoln Mullen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.6.2
 - !ruby/object:Gem::Dependency
   name: rest
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md