noids_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f84c41e5fda4436621de5c0dadb9939753f4a804
+  data.tar.gz: e43be3ae32af0efebd19f9086717ae313d95067c
+SHA512:
+  metadata.gz: 9b2bb7f767b7568e7acabeadce6f245e435a9ddc568ad1791c007a74fcb9ccf4c5e7f0a155c4e7784f681edc6f6588a4dfec990c7a4591cf832f169c53539f23
+  data.tar.gz: 0babfde7d9a137eefa87b2b1c44f62022ac9a2dacbce3e91aa1e683e9de454c9fc4260b8b0600d351555365784dcef84db625b59ae43060bab8c284c6b640cf6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in noids_client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2014 University of Notre Dame
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+

data/README.md

@@ -0,0 +1,84 @@
+NoidsClient
+===========
+
+NoidsClient provides a wrapper around the [noids server](https://github.com/dbrower/noids) REST API.
+This is the thinnest wrapper possible. Don't expect any sophisticated behavior.
+
+# Usage
+
+```ruby
+require 'noids_client'
+
+noids = NoidsClient::Connection.new("localhost:13001")
+noids.pool_list      # = ["sdfg"]
+noids.server_version # = "1.0.1"
+mypool = noids.new_pool("mypool", ".zdddk")
+mypool.mint # = ["0000"]
+p = noids.get_pool("sdfg")  # load a pool which has already been created
+p.name     # = "sdfg"
+p.closed?  # = false
+p.last_mint_date # = #<DateTime: 2014-06-16T14:27:19-04:00 ((2456825j,66439s,22553001n),-14400s,2299161j)>
+p.template # = ".zeeek+24457"
+p.ids_used # = 24457
+p.max_ids  # = Float::INFINITY
+p.mint     # = ["102bm"]
+p.mint(50) # = ["102cr", "102dw", ..., "1042q"]
+p.close    # closes the pool to new minting
+p.closed?  # = true
+p.open     # opens the pool to new minting (provided there are more ids available for minting)
+p.advance_past('zzzs')
+p.update   # reloads ids_used and last_mint_date from the server
+```
+
+# Notes
+
+* `mint` will only take an argument between 1 and 1000, inclusive. Other values will cause an exception.
+This limitation is imposed by the server.
+* In the case of connection issues, exceptions are raised.
+
+# Setting up a noids server
+
+A noids server is not provided by this repository.
+However, for testing or experimentation it is convinent to set up a noids server, which is not difficult.
+
+## On a Mac with homebrew
+
+First install a golang environment.
+
+    brew install go
+    mkdir ~/gocode
+    export GOPATH=~/gocode
+    export PATH=$GOPATH/bin:$PATH
+
+Install the noids server:
+
+    go get https://github.com/dbrower/noids
+
+Start it, and have it keep pools in memory.
+
+    noids
+
+These pools will be lost when the server is restarted.
+To save the pools to disk use
+
+    noids -storage directory/to/use
+
+There are other options, including saving the pools to a database.
+See the documentation on the [noids server](https://github.com/dbrower/noids) page.
+
+You can test the server using `curl`.
+Note that the default port for the server to listen on is 13001.
+These commands will create a pool named 'test' which will generate ids using the template `.sddd`.
+Then 50 ids are minted, and the pool is advanced past the id `432`, so that `432` will never be minted by this pool.
+
+    curl 'http://localhost:13001/pools' -F 'name=test' -F 'template=.sddd'
+    curl 'http://localhost:13001/pools/test/mint' -F 'n=50'
+    curl 'http://localhost:13001/pools/test/advancePast' -F 'id=432'
+
+
+## On Linux
+
+Install a golang envrionment. This should be done using your package management system.
+e.g. `yum install golang`.
+Then follow the remaining steps above.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/noids_client.rb

@@ -0,0 +1,7 @@
+require 'rest-client'
+require 'json'
+
+require 'noids_client/pool'
+require 'noids_client/connection'
+require 'noids_client/version'
+

data/lib/noids_client/connection.rb

@@ -0,0 +1,37 @@
+#
+# Connection remembers how to contact a given noids server
+#
+module NoidsClient
+  class Connection
+
+    attr_reader :server_version
+
+    def initialize(url)
+      @noids = ::RestClient::Resource.new(url)
+      update
+    end
+
+    def new_pool(name, template)
+      @noids['pools'].post '', params: {name: name, template: template}
+      get_pool(name)
+    end
+
+    def get_pool(name)
+      Pool.new(@noids["pools/#{name}"])
+    end
+
+    def pool_list
+      JSON.parse(@noids['pools'].get)
+    end
+
+    def update
+      parse_stats(@noids['stats'].get)
+    end
+
+    private
+    def parse_stats(json_string)
+      stats = JSON.parse(json_string)
+      @server_version = stats['Version']
+    end
+  end
+end

data/lib/noids_client/pool.rb

@@ -0,0 +1,51 @@
+require 'date'
+
+module NoidsClient
+  class Pool
+
+    attr_reader :name, :template, :ids_used, :max_ids, :last_mint_date
+
+    def initialize(rest_resource)
+      @noid_pool = rest_resource
+      update
+    end
+
+    def update
+      decode_json(@noid_pool.get)
+    end
+
+    def open
+      decode_json(@noid_pool['open'].put '')
+    end
+
+    def close
+      decode_json(@noid_pool['close'].put '')
+    end
+
+    def closed?
+      @is_closed
+    end
+
+    def mint(this_many_ids=1)
+      JSON.parse(@noid_pool['mint'].post '', params: {n: this_many_ids})
+    end
+
+    def advance_past(this_id)
+      decode_json(@noid_pool['advancePast'].post '', params: {id: this_id})
+    end
+
+    private
+    def decode_json(json_string)
+      info = JSON.parse(json_string)
+      @name = info['Name']
+      @template = info['Template']
+      @ids_used = info['Used']
+      @max_ids = info['Max']
+      if @max_ids == -1
+        @max_ids = Float::INFINITY
+      end
+      @is_closed = info['Closed']
+      @last_mint_date = DateTime.rfc3339(info['LastMint'])
+    end
+  end
+end

data/lib/noids_client/version.rb

@@ -0,0 +1,3 @@
+module NoidsClient
+  VERSION = "0.0.1"
+end

data/noids_client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'noids_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'noids_client'
+  spec.version     = NoidsClient::VERSION
+  spec.summary     = 'Ruby client for a NOIDS server'
+  spec.description = %q{Provides an idiomatic interface to the REST API of a noids server (see https://github.com/dbrower/noids)}
+  spec.authors     = ['Don Brower']
+  spec.email       = ['dbrower@nd.edu']
+  spec.license     = 'APACHE2'
+  spec.homepage    = 'https://github.com/ndlib/noids_client'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client', '~> 1.6'
+  spec.add_dependency 'json', '~> 1.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 2.8'
+  spec.add_development_dependency 'webmock', '~> 1.17'
+end
+

data/spec/cassettes/integration-1.yml

@@ -0,0 +1,283 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:13001/stats
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 17 Jun 2014 20:47:07 GMT
+      Content-Length:
+      - '20'
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |
+        {"Version":"1.0.1"}
+    http_version: 
+  recorded_at: Tue, 17 Jun 2014 20:47:07 GMT
+- request:
+    method: get
+    uri: http://localhost:13001/pools
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 17 Jun 2014 20:47:07 GMT
+      Content-Length:
+      - '3'
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |
+        []
+    http_version: 
+  recorded_at: Tue, 17 Jun 2014 20:47:07 GMT
+- request:
+    method: get
+    uri: http://localhost:13001/pools
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 17 Jun 2014 20:47:07 GMT
+      Content-Length:
+      - '3'
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |
+        []
+    http_version: 
+  recorded_at: Tue, 17 Jun 2014 20:47:07 GMT
+- request:
+    method: post
+    uri: http://localhost:13001/pools?name=abcd&template=.sddd
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Length:
+      - '0'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Tue, 17 Jun 2014 20:47:07 GMT
+      Content-Length:
+      - '121'
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |
+        {"Name":"abcd","Template":".sddd+0","Used":0,"Max":1000,"Closed":false,"LastMint":"2014-06-17T16:47:07.397416664-04:00"}
+    http_version: 
+  recorded_at: Tue, 17 Jun 2014 20:47:07 GMT
+- request:
+    method: get
+    uri: http://localhost:13001/pools/abcd
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 17 Jun 2014 20:47:07 GMT
+      Content-Length:
+      - '121'
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |
+        {"Name":"abcd","Template":".sddd+0","Used":0,"Max":1000,"Closed":false,"LastMint":"2014-06-17T16:47:07.397416664-04:00"}
+    http_version: 
+  recorded_at: Tue, 17 Jun 2014 20:47:07 GMT
+- request:
+    method: post
+    uri: http://localhost:13001/pools/abcd/advancePast?id=100
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Length:
+      - '0'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 17 Jun 2014 20:47:07 GMT
+      Content-Length:
+      - '125'
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |
+        {"Name":"abcd","Template":".sddd+101","Used":101,"Max":1000,"Closed":false,"LastMint":"2014-06-17T16:47:07.407251383-04:00"}
+    http_version: 
+  recorded_at: Tue, 17 Jun 2014 20:47:07 GMT
+- request:
+    method: post
+    uri: http://localhost:13001/pools/abcd/mint?n=2
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Length:
+      - '0'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 17 Jun 2014 20:47:07 GMT
+      Content-Length:
+      - '14'
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |
+        ["101","102"]
+    http_version: 
+  recorded_at: Tue, 17 Jun 2014 20:47:07 GMT
+- request:
+    method: put
+    uri: http://localhost:13001/pools/abcd/close
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Length:
+      - '0'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 17 Jun 2014 20:47:07 GMT
+      Content-Length:
+      - '124'
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |
+        {"Name":"abcd","Template":".sddd+103","Used":103,"Max":1000,"Closed":true,"LastMint":"2014-06-17T16:47:07.413350405-04:00"}
+    http_version: 
+  recorded_at: Tue, 17 Jun 2014 20:47:07 GMT
+- request:
+    method: post
+    uri: http://localhost:13001/pools/abcd/mint?n=1
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Length:
+      - '0'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Content-Type:
+      - text/plain; charset=utf-8
+      Date:
+      - Tue, 17 Jun 2014 20:47:07 GMT
+      Content-Length:
+      - '15'
+    body:
+      encoding: UTF-8
+      string: |
+        Pool is closed
+    http_version: 
+  recorded_at: Tue, 17 Jun 2014 20:47:07 GMT
+recorded_with: VCR 2.8.0

data/spec/lib/integration_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe "Integration" do
+  it "handles a normal situation correctly" do
+    VCR.use_cassette('integration-1') do
+      c = NoidsClient::Connection.new('http://localhost:13001')
+      expect(c.pool_list).to be_a(Array)
+      expect(c.pool_list).to be_empty
+      p = c.new_pool("abcd", ".sddd")
+      expect(p.name).to eq("abcd")
+      expect(p.template).to eq(".sddd+0")
+      expect(p.closed?).to be_falsy
+      expect(p.ids_used).to eq(0)
+      expect(p.max_ids).to eq(1000)
+      p.advance_past("100")
+      expect(p.ids_used).to eq(101)
+      expect(p.mint(2)).to eq(["101", "102"])
+      p.close
+      expect(p.closed?).to be_truthy
+      expect {p.mint}.to raise_error
+    end
+  end
+end

data/spec/lib/pool_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe NoidsClient::Pool do
+  it "decodes json" do
+    response = %q{{"Name":"abc","Template":".zeee+0","Used":0,"Max":-1,"Closed":false,"LastMint":"2014-06-16T14:27:19.022553001-04:00"}}
+    rest_resource = double("rest_resource", get: response)
+    pool = NoidsClient::Pool.new(rest_resource)
+    expect(pool.name).to eq("abc")
+    expect(pool.template).to eq(".zeee+0")
+    expect(pool.ids_used).to eq(0)
+    expect(pool.max_ids).to eq(Float::INFINITY)
+    expect(pool.closed?).to be_falsey
+    expect(pool.last_mint_date).to be_a(DateTime)
+    expect(pool.last_mint_date.day).to eq(16)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'vcr'
+
+require 'noids_client'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: noids_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Don Brower
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+description: Provides an idiomatic interface to the REST API of a noids server (see
+  https://github.com/dbrower/noids)
+email:
+- dbrower@nd.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/noids_client.rb
+- lib/noids_client/connection.rb
+- lib/noids_client/pool.rb
+- lib/noids_client/version.rb
+- noids_client.gemspec
+- spec/cassettes/integration-1.yml
+- spec/lib/integration_spec.rb
+- spec/lib/pool_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ndlib/noids_client
+licenses:
+- APACHE2
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Ruby client for a NOIDS server
+test_files:
+- spec/cassettes/integration-1.yml
+- spec/lib/integration_spec.rb
+- spec/lib/pool_spec.rb
+- spec/spec_helper.rb
+has_rdoc: