ezid 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDRiY2EzZmQ5ZjU5OTEwNTc2ZGUwZGY0YjNkNDI4ZGRiYjBiYTAyYg==
+  data.tar.gz: !binary |-
+    OTgxZjQ0Y2Y0MWRhMDllZWZjY2YwOTliZjAxMzQxZDEzMTcwZTMzMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MzYxYWE2MjlmZWQwODRmZGRkNjUzNWM2NDgxYjcyMzBiZjY0YWQwMjk2YjNm
+    NDAxODhkMDBlNjkxODBhNjU3MGI1ZTAxNThlMzMwZWRmNDM3OTU0OTIxNDk0
+    M2I4NmJiM2VjZTY0YTQxOWZkMjk4ZGJjYjM3OTA0NTIyNDgyYmI=
+  data.tar.gz: !binary |-
+    MDUyMTI1YWM4MGQ3YTU2NzkxY2RmZmE0MTg2NzI5MmYxNjI2NWI3NDVkYzdi
+    MGY4OTAwNzgzZjcwOTIxY2EyNDFmY2Y3NDE5MzQyMWQ5YjFlNTQxMWY5ZmI5
+    YjExOGJjNzRmOTRhYjExZmZiNTk0NGEyZWUzYzc1MzgyMjk4YzQ=

data/lib/ezid.rb

@@ -0,0 +1,175 @@
+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 Poppe\
+r', '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 = scheme
+    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

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: ezid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-21 00:00:00.000000000 Z
+dependencies: []
+description: API client for California Digital Library's EZID service.
+email: thomas.johnson@oregonstate.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ezid.rb
+homepage: http://achelo.us/code/ezid_api
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: API client for California Digital Library's EZID service.
+test_files: []
+has_rdoc: