ezid 0.2.0 → 0.2.1

data/lib/ezid.rb

@@ -1 +1,3 @@
-require 'ezid/apisession'
+# -*- coding: utf-8 -*-
+
+require 'ezid/apisession'

data/lib/ezid/apisession.rb

@@ -1,25 +1,33 @@
+# -*- coding: utf-8 -*-
+
 require 'net/http'
 require 'ezid/record'
 require 'ezid/server_response'
+
 module Ezid
   class ApiSession
+    attr_accessor :naa, :username, :password
+    attr_reader :scheme
 
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
     APIVERSION = 'EZID API, Version 2'
 
-    SECURESERVER = "https://n2t.net/ezid"
+    SECURESERVER = 'https://n2t.net/ezid'
     TESTUSERNAME = 'apitest'
     TESTPASSWORD = 'apitest'
-    SCHEMES = {:ark => 'ark:/', :doi => "doi:"}
+    SCHEMES = { :ark => 'ark:/', :doi => 'doi:' }
 
-    PRIVATE = "reserved"
-    PUBLIC = "public"
-    UNAVAIL = "unavailable"
+    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'}
+    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='')
+    def initialize(username = TESTUSERNAME, password = TESTPASSWORD, scheme = :ark, naa = '')
       if username == TESTUSERNAME
         password = TESTPASSWORD
         @test = true
@@ -32,62 +40,59 @@ module Ezid
       @scheme = SCHEMES[scheme]
       @naa = naa
 
-      if @test == true
-        @naa = TESTSHOULDER[@scheme]
-      end
+      @naa = TESTSHOULDER[@scheme] if @test == true
+      self
     end
 
-    def mint(metadata={})
+    def mint(metadata = {})
       shoulder = @scheme + @naa
       metadata['_status'] = PRIVATE
-      #TODO: send mint request to API
-      request_uri = "/shoulder/" + shoulder
+      request_uri = "/shoulder/#{shoulder}"
       request = call_api(request_uri, :post, metadata)
-      if(request.errored?)
-        return request
-      else
-        return get(request)
-      end
+      return request if request.errored?
+
+      get(request)
     end
 
-    def create(identifier, metadata={})
+    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_uri = '/id/' + build_identifier(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
+      metadata['_status'] = PRIVATE unless metadata['_status']
+      metadata
     end
+
     def build_identifier(identifier)
-      "#{@scheme}#{@naa}#{identifier}"
+      unless identifier.start_with?(ApiSession::SCHEMES[:ark]) ||
+          identifier.start_with?(ApiSession::SCHEMES[:doi])
+        identifier = @scheme + @naa + identifier
+      end
+      identifier
     end
+
     def get(identifier)
-      request_uri = "/id/" + identifier
+      identifier = identifier.to_str
+      identifier = identifier.split(' | ')[0] if identifier.include?('| ark:/')
+      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
+      return request if request.errored?
+      Ezid::Record.new(self, request.response['identifier'], request.response['metadata'], true)
     end
 
     def delete(identifier)
-      request_uri = "/id/" + identifier
+      request_uri = '/id/' + identifier
       call_api(request_uri, :delete)
     end
 
     # public utility methods
 
-    def record_modify(identifier, metadata, clear=false)
+    def record_modify(identifier, metadata, clear = false)
       if clear
-        #TODO: clear old metadata
+        # TODO: clear old metadata
       end
       metadata.each do |name, value|
         modify(identifier, name, value)
@@ -97,18 +102,13 @@ module Ezid
 
     def scheme=(scheme)
       @scheme = SCHEMES[scheme]
-      if @test == true
-        @naa = TESTSHOULDER[@scheme]
-      end
-    end
-
-    def naa=(naa)
-      @naa = naa
+      @naa = TESTSHOULDER[@scheme] if @test == true
+      @scheme
     end
 
     private
 
-    def call_api(request_uri, request_method, request_data=nil)
+    def call_api(request_uri, request_method, request_data = nil)
       uri = URI(SECURESERVER + request_uri)
 
       # which HTTP method to use?
@@ -125,25 +125,25 @@ module Ezid
       end
 
       request.basic_auth @user, @pass
-      request.add_field("Content-Type", "text/plain; charset=UTF-8")
+      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)
+      Ezid::ServerResponse.new(result)
     end
 
     def parse_record(ezid_response)
       parts = ezid_response.split("\n")
-      identifier = parts[0].split(": ")[1]
+      identifier = parts[0].split(': ')[1]
       metadata = {}
       if parts.length > 1
         parts[1..-1].each do |p|
-          pair = p.split(": ")
+          pair = p.split(': ')
           metadata[pair[0]] = pair[1]
         end
-        record = {'identifier' => identifier, 'metadata' => metadata}
+        record = { 'identifier' => identifier, 'metadata' => metadata }
       else
         record = identifier
       end
@@ -151,7 +151,6 @@ module Ezid
     end
 
     def make_anvl(metadata)
-      #TODO: define escape method for anvl
       def escape(s)
         URI.escape(s, /[%:\n\r]/)
       end
@@ -159,10 +158,9 @@ module Ezid
       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")
+      # remove last newline. there is probably a really good way to
+      # 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

@@ -1,7 +1,9 @@
+# -*- coding: utf-8 -*-
+
 module Ezid
   class Record
     attr_reader :identifier, :metadata
-    def initialize(session, identifier, metadata={},persisted=false)
+    def initialize(session, identifier, metadata = {}, persisted = false)
       @identifier = identifier
       @metadata = metadata
       @session = session
@@ -10,72 +12,82 @@ module Ezid
       @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
+      if self.stale?
+        new_record = @session.get(@identifier)
+        @identifier = new_record.identifier
+        @metadata = new_record.metadata
         @stale = false
       end
-      return self
+      self
     end
+
     def persisted?
       @changed.length != 0 ? false : @persisted
     end
+
     def [](attribute)
       @metadata[attribute]
     end
-    def []=(attribute,value)
-      if(@metadata[attribute] != value)
+
+    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]}
+      modify_data = @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
+      result = @session.send(:call_api, request_uri, :post, modify_data)
+      raise "Unable to save - error: #{result.response}" if result.errored?
       @persisted = true
       @stale = true
       @changed = []
-      return self
+      self
     end
+
+    def stale?
+      @stale
+    end
+
     # Utility Methods
     def make_public
-      self["_status"] = Ezid::ApiSession::PUBLIC
+      self['_status'] = Ezid::ApiSession::PUBLIC
     end
 
     def make_unavailable
-      self["_status"] = Ezid::ApiSession::UNAVAIL
+      self['_status'] = Ezid::ApiSession::UNAVAIL
     end
+
     # Shortcut methods - leave behind from old implementation.
     def status
-      self["_status"]
+      self['_status']
     end
+
     def target
-      self["_target"]
+      self['_target']
     end
+
     def target=(value)
-      self["_target"] = value
+      self['_target'] = value
     end
+
     def profile
-      self["_profile"]
+      self['_profile']
     end
+
     def profile=(value)
-      self["_profile"] = value
+      self['_profile'] = value
     end
   end
-end
+end

data/lib/ezid/server_response.rb

@@ -1,14 +1,19 @@
+# -*- coding: utf-8 -*-
+
 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")
+      @response.instance_of?(String) && @response.start_with?('bad request')
     end
+
     def to_str
       @response.to_s
     end
   end
-end
+end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: ezid
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
+  prerelease: 
 platform: ruby
 authors:
 - Thomas Johnson
@@ -21,26 +22,28 @@ files:
 - lib/ezid/record.rb
 - lib/ezid/server_response.rb
 homepage: http://achelo.us/code/ezid_api
-licenses: []
-metadata: {}
+licenses:
+- Public Domain
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: API client for California Digital Library's EZID service.
 test_files: []

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MWU1ZmY2ZjcyNzU5MjM5OTYzYjY0YzVhMDY1Yzg4NTQ5NDVmMTgwNQ==
-  data.tar.gz: !binary |-
-    ZmM4NTE0Mjk1MGQwZWQwNWExY2Q2MmFjNWFkNjYwMDIwNmUxNDYzNg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NTA4ZGVhY2QzZGQ1NDFjYjY5ZjIzOGJmOWJmYWYzOTc2ZGRhZTQwOGEyYWMx
-    OTgzNzQ1OTkwZjI3NGUyYTkxOWQ4NzYxYTkzY2EwYjZlODZkZGU1Yzc2MDEz
-    ZmQwNGRhNDY3ODgzZmZhNmM5Y2EwOTA4ZDZlMDljNDc1NWJkNTY=
-  data.tar.gz: !binary |-
-    NmQ0ZjU2OGYwMmZiMmViYWYwMWQxZDMzZjFkMzgwNTQzOGRmOTBiN2FjODYy
-    OGYzMGEzNTg3ODdmZTY0ZTJiMThlZjI1NGY0YzFkNzI1YTYxMDUxNTI3OTMw
-    NzNlNzdiMWYwMmRiZTJkOTllZTFiMjNhNDM4M2VjNzc5ODFiNmM=