collectiveaccess 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41b9a4d1c86b0c70ec8907524656fadf8cb6de1d
-  data.tar.gz: 6fd0d95fab36a585d7b7be37b0a892fa228651db
+  metadata.gz: 2c1de3393ad65a3d0c4f62fe76950d9ff8f4a688
+  data.tar.gz: 8931df984446dbb7c24061f30b8b9ebf6a5b6320
 SHA512:
-  metadata.gz: 9f20ca9eaa6ac8bdf1ecc5001609147eba4af61f3bed0d7d92447dabf45772b460ac61a04a8921dd4e9d98e0367ba4296221f152994e46a941a21a11a825fb63
-  data.tar.gz: c62aed278aea70da93fb904d3c9cbfc3f728a057ace3795d10599ef3df3a814f2471b1952f97e607bd711acf49895d27c75d7c8e6f7b2affc170a85547fea8c4
+  metadata.gz: e150ea9236089dbb62b7c9e4ea4c468731f7baa224c46e58bd61d6ba690ac3938c8a3b57bdb207764d145e5385f891541e1f6413b6786bf8dea620760debe604
+  data.tar.gz: 30d9a89cf8936efdd266efce87a7f87bfce57943e2990da417e5747fc382ef802f881f38e8d1b3544fee5ab9b609b5555acfe38d67772e49aa09336b5837d199

data/README.rdoc

@@ -4,6 +4,9 @@ This gem is a simple plain Ruby wrapper for the {CollectiveAccess}[http://www.co
 Web {Service API}[docs.collectiveaccess.org/wiki/Web_Service_API]. Before you start fiddling with
 the gem, make sure you're familiar with the API.
 
+Note that this library requires CollectiveAccess Providence v1.5 or later! It might work with v1.4
+but we don't test it against the old stable code.
+
 == Setup
 
 Through RubyGems:
@@ -12,7 +15,7 @@ Through RubyGems:
 
 In a Gemfile:
 
-    gem 'collectiveaccess', '~> 0.1.0'
+    gem 'collectiveaccess', '~> 0.2.0'
 
 == Usage
 
@@ -95,6 +98,16 @@ All of them assume that you have required the 'collectiveaccess' gem and also th
                              }
     puts "#{r}"
 
+=== "Simple" API
+
+In v1.6 of CollectiveAccess there's a new service interface called
+{Simple API}[http://docs.collectiveaccess.org/wiki/SimpleAPI]. Gem versions v0.2.x and later support querying
+this API using the `simple` class method. Below is an example for the endpoint 'testDetail'. Note that you have
+to define the endpoint first in your CollectiveAccess services configuration for this to work. For more info
+take a look at the {documentation}[http://docs.collectiveaccess.org/wiki/SimpleAPI]:
+
+    r = CollectiveAccess.simple hostname: 'providence.dev', endpoint: 'testDetail', get_params: { id: 1 }
+
 == Contributing to collectiveaccess
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/Rakefile

@@ -16,7 +16,7 @@ Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
   gem.name = 'collectiveaccess'
   gem.homepage = 'http://github.com/CollectiveAccessProject/collectiveaccess'
-  gem.license = 'MIT'
+  gem.license = 'GPL3'
   gem.summary = 'Ruby wrapper for CollectiveAccess Web Service API'
   gem.description = 'This gem is a simple plain Ruby wrapper for the CollectiveAccess Web Service API. For more info see https://github.com/CollectiveAccessProject/collectiveaccess'
   gem.email = 'info@collectiveaccess.org'

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/collectiveaccess.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: collectiveaccess 0.1.0 ruby lib
+# stub: collectiveaccess 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "collectiveaccess"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["CollectiveAccess", "Stefan"]
-  s.date = "2015-07-22"
+  s.date = "2015-08-14"
   s.description = "This gem is a simple plain Ruby wrapper for the CollectiveAccess Web Service API. For more info see https://github.com/CollectiveAccessProject/collectiveaccess"
   s.email = "info@collectiveaccess.org"
   s.extra_rdoc_files = [
@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
     "test/test_collectiveaccess.rb"
   ]
   s.homepage = "http://github.com/CollectiveAccessProject/collectiveaccess"
-  s.licenses = ["MIT"]
+  s.licenses = ["GPL3"]
   s.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
   s.rubygems_version = "2.4.6"
   s.summary = "Ruby wrapper for CollectiveAccess Web Service API"

data/lib/collectiveaccess.rb

@@ -58,6 +58,24 @@ class CollectiveAccess
     custom_request :delete, request_opts
   end
 
+  def self.simple(request_opts = {})
+    opts = parse_options request_opts
+    uri = build_simple_uri opts
+
+    resp = HTTParty.public_send :get, uri
+
+    # if 401 (access denied), try to re-authenticate
+    if resp.code == 401
+      delete_stored_auth_token # nuke old token
+      authenticate opts
+      # have to re-build the URI to include the new auth token
+      new_uri = build_simple_uri opts
+      # try again
+      resp = HTTParty.public_send :get, new_uri
+    end
+    resp.parsed_response
+  end
+
   # Core request method. Tries to send the request with the given parameters. If it encounters a 401
   # it'll try to re-authenticate with the Web Service API and retries the same request. Returns a
   # parsed Hash containing the JSON response from the API or false if something went wrong.
@@ -89,6 +107,16 @@ class CollectiveAccess
     url
   end
 
+  def self.build_simple_uri(opts)
+    # URI available params: scheme, userinfo, host, port, registry, path, opaque, query and fragment
+    url = URI::HTTP.build({ :scheme => opts[:protocol],
+                            :host => opts[:hostname],
+                            :path => opts[:url_root]+opts[:script_name]+'/simple/'+opts[:endpoint],
+                            :query => URI.encode_www_form(opts[:get_params].merge(authToken: stored_auth_token)) })
+    url.path.gsub! %r{/+}, '/'
+    url
+  end
+
   def self.pstore
     PStore.new(Dir.tmpdir + File::PATH_SEPARATOR + 'collectiveaccess_gem_token.pstore')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: collectiveaccess
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - CollectiveAccess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-22 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -116,7 +116,7 @@ files:
 - test/test_collectiveaccess.rb
 homepage: http://github.com/CollectiveAccessProject/collectiveaccess
 licenses:
-- MIT
+- GPL3
 metadata: {}
 post_install_message: 
 rdoc_options: []