ezid 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTk2NWU3ZjEzNzVhNzcxYzM0Y2NmNWJlZWE5Y2JmMTM3ZTc4M2NiNQ==
+    MWU1ZmY2ZjcyNzU5MjM5OTYzYjY0YzVhMDY1Yzg4NTQ5NDVmMTgwNQ==
   data.tar.gz: !binary |-
-    ZGNiODNhNjZmMGM1MDQzODBmMzg0MDdiODY4ZjQ1MGQ0NDAyOTY2NQ==
+    ZmM4NTE0Mjk1MGQwZWQwNWExY2Q2MmFjNWFkNjYwMDIwNmUxNDYzNg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MThmNGQwMzY5NDRlYjBiMjllOWUyZDMzYWQyMzQ2N2U2ZTFlYWRiNjZiZmY3
-    ZDY0OGJiOGZiYmU4YTdkZTY2ODk0MzBmYjhjZGZlMmZlNTBhYzZmNGYyN2M3
-    YWI2ZTY1NDcwZjVkMjc0ODg4MGU4ZmMzMzQyY2EzODg0MmI4YjM=
+    NTA4ZGVhY2QzZGQ1NDFjYjY5ZjIzOGJmOWJmYWYzOTc2ZGRhZTQwOGEyYWMx
+    OTgzNzQ1OTkwZjI3NGUyYTkxOWQ4NzYxYTkzY2EwYjZlODZkZGU1Yzc2MDEz
+    ZmQwNGRhNDY3ODgzZmZhNmM5Y2EwOTA4ZDZlMDljNDc1NWJkNTY=
   data.tar.gz: !binary |-
-    YzYyMjg5NTI5YWI3YjllYWZhNzc0NjQyYjM2NDExZGY3NGFhM2E0OGVmNmMx
-    MDA4YTkwYzIyMjc4NDY3MjRjMjRmYjgyN2Q1OGY3YjA4ZjUxNzU3Nzg5ZDZj
-    MjFhZGI5NDFmNWE0NGQwMTUxNzgxNDJjZmRlYTg1YWZkM2E4ZTg=
+    NmQ0ZjU2OGYwMmZiMmViYWYwMWQxZDMzZjFkMzgwNTQzOGRmOTBiN2FjODYy
+    OGYzMGEzNTg3ODdmZTY0ZTJiMThlZjI1NGY0YzFkNzI1YTYxMDUxNTI3OTMw
+    NzNlNzdiMWYwMmRiZTJkOTllZTFiMjNhNDM4M2VjNzc5ODFiNmM=

data/lib/ezid/apisession.rb

@@ -0,0 +1,168 @@
+require 'net/http'
+require 'ezid/record'
+require 'ezid/server_response'
+module Ezid
+  class ApiSession
+
+    VERSION = '0.2.0'
+    APIVERSION = 'EZID API, Version 2'
+
+    SECURESERVER = "https://n2t.net/ezid"
+    TESTUSERNAME = 'apitest'
+    TESTPASSWORD = 'apitest'
+    SCHEMES = {:ark => 'ark:/', :doi => "doi:"}
+
+    PRIVATE = "reserved"
+    PUBLIC = "public"
+    UNAVAIL = "unavailable"
+
+    TESTSHOULDER = {SCHEMES[:ark] => '99999/fk4', SCHEMES[:doi] => '10.5072/FK2'}
+    TESTMETADATA = {'_target' => 'http://example.org/opensociety', 'erc.who' => 'Karl Popper', 'erc.what' => 'The Open Society and Its Enemies', 'erc.when' => '1945'}
+
+    def initialize(username=TESTUSERNAME, password=TESTPASSWORD, scheme=:ark, naa='')
+      if username == TESTUSERNAME
+        password = TESTPASSWORD
+        @test = true
+      else
+        @test = false
+      end
+
+      @user = username
+      @pass = password
+      @scheme = SCHEMES[scheme]
+      @naa = naa
+
+      if @test == true
+        @naa = TESTSHOULDER[@scheme]
+      end
+    end
+
+    def mint(metadata={})
+      shoulder = @scheme + @naa
+      metadata['_status'] = PRIVATE
+      #TODO: send mint request to API
+      request_uri = "/shoulder/" + shoulder
+      request = call_api(request_uri, :post, metadata)
+      if(request.errored?)
+        return request
+      else
+        return get(request)
+      end
+    end
+
+    def create(identifier, metadata={})
+      metadata = transform_metadata(metadata)
+      if not (identifier.start_with?(SCHEMES[:ark]) or identifier.start_with?(SCHEMES[:doi]))
+        identifier = @scheme + @naa + identifier
+      end
+      request_uri = "/id/" + identifier
+      request = call_api(request_uri, :put, metadata)
+      request.errored? ? request : get(request)
+    end
+    def transform_metadata(metadata)
+      if !metadata['_status']
+        metadata['_status'] = PRIVATE
+      end
+      return metadata
+    end
+    def build_identifier(identifier)
+      "#{@scheme}#{@naa}#{identifier}"
+    end
+    def get(identifier)
+      request_uri = "/id/" + identifier
+      request = call_api(request_uri, :get)
+      if(request.errored?)
+        return request
+      else
+        return Ezid::Record.new(self,request.response["identifier"],request.response["metadata"],true)
+      end
+    end
+
+    def delete(identifier)
+      request_uri = "/id/" + identifier
+      call_api(request_uri, :delete)
+    end
+
+    # public utility methods
+
+    def record_modify(identifier, metadata, clear=false)
+      if clear
+        #TODO: clear old metadata
+      end
+      metadata.each do |name, value|
+        modify(identifier, name, value)
+      end
+      get(identifier)
+    end
+
+    def scheme=(scheme)
+      @scheme = SCHEMES[scheme]
+      if @test == true
+        @naa = TESTSHOULDER[@scheme]
+      end
+    end
+
+    def naa=(naa)
+      @naa = naa
+    end
+
+    private
+
+    def call_api(request_uri, request_method, request_data=nil)
+      uri = URI(SECURESERVER + request_uri)
+
+      # which HTTP method to use?
+      if request_method == :get
+        request = Net::HTTP::Get.new uri.request_uri
+      elsif request_method == :put
+        request = Net::HTTP::Put.new uri.request_uri
+        request.body = make_anvl(request_data)
+      elsif request_method == :post
+        request = Net::HTTP::Post.new uri.request_uri
+        request.body = make_anvl(request_data)
+      elsif request_method == :delete
+        request = Net::HTTP::Delete.new uri.request_uri
+      end
+
+      request.basic_auth @user, @pass
+      request.add_field("Content-Type", "text/plain; charset=UTF-8")
+
+      # Make the call
+      result = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+        parse_record http.request(request).body
+      end
+      return Ezid::ServerResponse.new(result)
+    end
+
+    def parse_record(ezid_response)
+      parts = ezid_response.split("\n")
+      identifier = parts[0].split(": ")[1]
+      metadata = {}
+      if parts.length > 1
+        parts[1..-1].each do |p|
+          pair = p.split(": ")
+          metadata[pair[0]] = pair[1]
+        end
+        record = {'identifier' => identifier, 'metadata' => metadata}
+      else
+        record = identifier
+      end
+      record
+    end
+
+    def make_anvl(metadata)
+      #TODO: define escape method for anvl
+      def escape(s)
+        URI.escape(s, /[%:\n\r]/)
+      end
+      anvl = ''
+      metadata.each do |n, v|
+        anvl += escape(n.to_s) + ': ' + escape(v.to_s) + "\n"
+      end
+      #remove last newline. there is probably a really good way avoid adding it in the first place. if you know it, please fix.
+      anvl.strip().encode!("UTF-8")
+    end
+
+  end
+
+end

data/lib/ezid/record.rb

@@ -0,0 +1,81 @@
+module Ezid
+  class Record
+    attr_reader :identifier, :metadata
+    def initialize(session, identifier, metadata={},persisted=false)
+      @identifier = identifier
+      @metadata = metadata
+      @session = session
+      @changed = []
+      @stale = false
+      @persisted = persisted
+      self
+    end
+    # There has to be a better way to do this.
+    def reload
+      if(self.stale?)
+        newRecord = @session.get(@identifier)
+        @identifier = newRecord.identifier
+        @metadata = newRecord.metadata
+        @stale = false
+      end
+      return self
+    end
+    def persisted?
+      @changed.length != 0 ? false : @persisted
+    end
+    def [](attribute)
+      @metadata[attribute]
+    end
+    def []=(attribute,value)
+      if(@metadata[attribute] != value)
+        @changed << attribute
+        @changed.uniq!
+      end
+      @metadata[attribute] = value
+    end
+    def delete
+      @session.delete(identifier)
+    end
+    # Returns true if the record has been saved but not reloaded.
+    def stale?
+      return @stale
+    end
+    def save
+      return self if self.persisted?
+      modifyData = @changed.each_with_object({}){|key, hash| hash[key] = @metadata[key]}
+      request_uri = "/id/#{@identifier}"
+      result = @session.send(:call_api,request_uri, :post, modifyData)
+      if(result.errored?)
+        raise "Unable to save - error: #{result.response}"
+      end
+      @persisted = true
+      @stale = true
+      @changed = []
+      return self
+    end
+    # Utility Methods
+    def make_public
+      self["_status"] = Ezid::ApiSession::PUBLIC
+    end
+
+    def make_unavailable
+      self["_status"] = Ezid::ApiSession::UNAVAIL
+    end
+    # Shortcut methods - leave behind from old implementation.
+    def status
+      self["_status"]
+    end
+    def target
+      self["_target"]
+    end
+    def target=(value)
+      self["_target"] = value
+    end
+    def profile
+      self["_profile"]
+    end
+    def profile=(value)
+      self["_profile"] = value
+    end
+  end
+end

data/lib/ezid/server_response.rb

@@ -0,0 +1,14 @@
+module Ezid
+  class ServerResponse
+    attr_reader :response
+    def initialize(response)
+      @response = response
+    end
+    def errored?
+      return @response.instance_of?(String) && @response.start_with?("bad request")
+    end
+    def to_str
+      @response.to_s
+    end
+  end
+end

data/lib/ezid.rb

@@ -1,178 +1 @@
-require 'net/http'
-
-module Ezid
-
-  class ApiSession
-
-
-    VERSION = '0.1.0'
-    APIVERSION = 'EZID API, Version 2'
-
-    SECURESERVER = "https://n2t.net/ezid"
-    TESTUSERNAME = 'apitest'
-    TESTPASSWORD = 'apitest'
-    SCHEMES = {:ark => 'ark:/', :doi => "doi:"}
-
-    PRIVATE = "reserved"
-    PUBLIC = "public"
-    UNAVAIL = "unavailable"
-    TESTSHOULDER = {SCHEMES[:ark] => '99999/fk4', SCHEMES[:doi] => '10.5072/FK2'}
-    TESTMETADATA = {'_target' => 'http://example.org/opensociety', 'erc.who' => 'Karl Popper', 'erc.what' => 'The Open Society and Its Enemies', 'erc.when' => '1945'}
-
-    def initialize(username=TESTUSERNAME, password=TESTPASSWORD, scheme=:ark, naa='')
-      if username == TESTUSERNAME
-        password = TESTPASSWORD
-        @test = true
-      else
-        @test = false
-      end
-
-      @user = username
-      @pass = password
-      @scheme = SCHEMES[scheme]
-      @naa = naa
-
-      if @test == true
-        @naa = TESTSHOULDER[@scheme]
-      end
-    end
-
-    def mint(metadata={})
-      shoulder = @scheme + @naa
-      metadata['_status'] = PRIVATE
-      #TODO: send mint request to API
-      request_uri = "/shoulder/" + shoulder
-      call_api(request_uri, :post, metadata)
-    end
-
-    def create(identifier, metadata={})
-      if not metadata['_status']
-        metadata['_status'] = PRIVATE
-      end
-      if not (identifier.start_with?(SCHEMES[:ark]) or identifier.start_with?(SCHEMES[:doi]))
-        identifier = @scheme + @naa + identifier
-      end
-      request_uri = "/id/" + identifier
-      call_api(request_uri, :put, metadata)
-    end
-
-    def modify(identifier, name, value)
-      request_uri = "/id/" + identifier
-      call_api(request_uri, :post, {name => value})
-    end
-
-    def get(identifier)
-      request_uri = "/id/" + identifier
-      call_api(request_uri, :get)
-    end
-
-    def delete(identifier)
-      request_uri = "/id/" + identifier
-      call_api(request_uri, :delete)
-    end
-
-    # public utility methods
-    def change_profile(identifier, profile)
-      modify(identifier, '_profile', profile)
-    end
-
-    def get_status(identifier)
-      get(identifier)['metadata']['_status']
-    end
-
-    def make_public(identifier)
-      modify(identifier, '_status', PUBLIC)
-    end
-
-    def make_unavailable(identifier)
-      modify(identifier, '_status', UNAVAIL)
-    end
-
-    def get_target(identifier)
-      get(identifier)['metadata']['_target']
-    end
-
-    def modify_target(identifier, target)
-      modify(identifier, '_target', target)
-    end
-
-    def record_modify(identifier, metadata, clear=false)
-      if clear
-        #TODO: clear old metadata
-      end
-      metadata.each do |name, value|
-        modify(identifier, name, value)
-      end
-      get(identifier)
-    end
-
-    def set_scheme(scheme)
-      @scheme = SCHEMES[scheme]
-      if @test == true
-        @naa = TESTSHOULDER[@scheme]
-      end
-    end
-
-    def set_naa(naa)
-      @naa = naa
-    end
-          
-    private
-    
-    def call_api(request_uri, request_method, request_data=nil)
-      uri = URI(SECURESERVER + request_uri)
-
-      # which HTTP method to use?
-      if request_method == :get
-        request = Net::HTTP::Get.new uri.request_uri
-      elsif request_method == :put
-        request = Net::HTTP::Put.new uri.request_uri
-        request.body = make_anvl(request_data)
-      elsif request_method == :post
-        request = Net::HTTP::Post.new uri.request_uri
-        request.body = make_anvl(request_data)
-      elsif request_method == :delete
-        request = Net::HTTP::Delete.new uri.request_uri
-      end
-      
-      request.basic_auth @user, @pass
-      request.add_field("Content-Type", "text/plain; charset=UTF-8")
-
-      # Make the call
-      Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
-        parse_record http.request(request).body
-      end
-    end
-
-    def parse_record(ezid_response)
-      parts = ezid_response.split("\n")
-      identifier = parts[0].split(": ")[1]
-      metadata = {}
-      if parts.length > 1
-        parts[1..-1].each do |p|
-          pair = p.split(": ")
-          metadata[pair[0]] = pair[1]
-        end
-        record = {'identifier' => identifier, 'metadata' => metadata}
-      else 
-        record = identifier
-      end
-      record
-    end
-
-    def make_anvl(metadata)
-      #TODO: define escape method for anvl
-      def escape(s)
-        URI.escape(s, /[%:\n\r]/)
-      end
-      anvl = ''
-      metadata.each do |n, v|
-        anvl += escape(n) + ': ' + escape(v) + "\n"
-      end
-      #remove last newline. there is probably a really good way avoid adding it in the first place. if you know it, please fix.
-      anvl.strip().encode!("UTF-8") 
-    end
-
-  end
-
-end
+require 'ezid/apisession'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezid
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Thomas Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-03-14 00:00:00.000000000 Z
 dependencies: []
 description: API client for California Digital Library's EZID service.
 email: thomas.johnson@oregonstate.edu
@@ -17,6 +17,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/ezid.rb
+- lib/ezid/apisession.rb
+- lib/ezid/record.rb
+- lib/ezid/server_response.rb
 homepage: http://achelo.us/code/ezid_api
 licenses: []
 metadata: {}
@@ -41,4 +44,3 @@ signing_key:
 specification_version: 4
 summary: API client for California Digital Library's EZID service.
 test_files: []
-has_rdoc: