rsbe-client 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9782c78a09597d6fee30ab7c6853c4a2c5ddce3d
-  data.tar.gz: 87adba5bdde063e8951e53499224037420ff4c12
+SHA256:
+  metadata.gz: cd4118feada708bc7e825e2eb5f27fe61b46cd2b0011f6333a25abc1b065b8d6
+  data.tar.gz: 44301a027fa8d33d5827a9442dba5c632f07a71332807373b4d563554972b5ab
 SHA512:
-  metadata.gz: b6769297879400a946220562a7e5a9fe1bb360773b1618246c54e7f9860dce6aab4bfb0bbab6cde1ae07c3b0e1940fa09d68a04961c2ecaff99e0984b400a0fc
-  data.tar.gz: ae2f8b4c95a096dc8d1a975fc7581efa23e42f4afd5dbdbeb7a4b325ddb869e4d79428988dec2a39c906d5b0975c10ef30d7480ec92b27cd166171339cbaed1d
+  metadata.gz: 79c9a557a85de6c91e84c2470520c8ae3fb888bc18a5c99b860559450812002ee1c5a5056309ce2e8836b2c9ecf5bb9e0d216958747ac58ae7ec871905132aff
+  data.tar.gz: 0125fcecd6341be56cad73f08b70a34009f9e7d0a38c2d1e793bd053a7d1f4e2f6aa488912f0d759b3107a704cb5eb27896036db841d8ce5260996c19442e066

data/README.md

@@ -10,13 +10,6 @@ Client library for interaction with the rsbe API
 
 This library allows one to interact with the R* Backend (rsbe) API.
 
-#### Completed User stories:
-* As an Authorized Client, I want to create a new Partner and have it persist.
-* As an Authorized Client, I want to update a Partner.
-* As an Authorized Client, I want to find a Partner by id.
-* As an Authorized Client, I want to get a list of all available Partners.
-
-
 #### Required Environment Variables:
 ```
 RSBE_URL
@@ -43,31 +36,28 @@ irb> Partner.all.each {|p| puts p.id}
 51213be7-c8de-4e06-8cc2-06bfc82cdd68
 977e659b-886a-4626-8799-8979426ad2b3
 ...
-```
-
-#### Usage (code example)
-```
-...
-def select_item_or_exit(items, label)
-  # do some stuff
-end
 ...
 
-partners = Rsbe::Client::Partner.all
-partners.sort! { |a, b| a.code <=> b.code }
-partner = select_item_or_exit(partners, 'partner')
+irb> p = Rsbe::Client::Partner.all.first
+ => #<Rsbe::Client::Partner:0x007fdc81b4ec08 ...>
 
-collections = partner.collections.sort { |a, b| a.code <=> b.code }
-collection = select_item_or_exit(collections, 'collection')
-puts "collection: #{collection.code}, #{collection.name} #{collection.id}"
-...
-```
+irb> puts "#{p.id} : #{p.code} : #{p.name}"
+51213be7-c8de-4e06-8cc2-06bfc82cdd68 : bar :
+ => nil 
+
+irb> p.name = 'Foo Bar'
+ => "Foo Bar"
+
+irb> p.save
+ => true 
+
+> p = Rsbe::Client::Partner.find('51213be7-c8de-4e06-8cc2-06bfc82cdd68')
+ => #<Rsbe::Client::Partner:0x007fdc81a3cdd8 ...>
+
+irb>   puts "#{p.id} : #{p.code} : #{p.name}"
+51213be7-c8de-4e06-8cc2-06bfc82cdd68 : bar : Foo Bar
+ => nil 
 
-#### Methods:
-```
-Rsbe::Partner#save
-Rsbe::Partner#code
-Rsbe::Partner#name
-Rsbe::Partner#collections
 ```
 
+

data/examples.md

@@ -0,0 +1,99 @@
+## `Rsbe::Client::SearchResults` examples:
+
+#### overview
+
+The `Rsbe::Client::SearchResults` class takes the results of an  
+`Rsbe::Client::Search` call, parses the results, and returns an  
+array of `Rsbe::Client::Se` objects.  
+
+You can use `Se` attribute values as search filters.
+
+
+##### Example: search by `digi_id`  
+
+The most common example is to retrieve the `Rsbe::Client::Se` object  
+for a digitization id (`digi_id`) registered in `Rsbe`.
+
+```
+irb> require 'rsbe/client'
+irb> response = Rsbe::Client::Se.search(digi_id: 'foo_quux_cuid0')
+ => #<Faraday::Response:0x007fdc819cd050 ...>
+
+irb> search_results = Rsbe::Client::SearchResults.new(response)
+ => #<Rsbe::Client::SearchResults:0x007fdc81943ee0 ...>
+
+irb> search_results.success?
+ => true
+
+irb> search_results.num_found
+ => 1
+
+irb> se = search_results.results.first
+ => #<Rsbe::Client::Se:0x007fdc819ffbb8 ...>
+
+irb> se.id
+ => "2edf966a-cde3-48e1-a04e-9c87af07b9b5"
+
+irb> se.digi_id
+ => "foo_quux_cuid0"
+
+irb> se.phase
+ => "digitization"
+
+irb> se.step
+ => "digitization"
+
+irb> se.status
+ => "queued"
+
+irb> se.status = 'error'
+ => "error"
+
+irb> se.save
+ => true
+
+```
+
+
+##### Example: search for all `Se`s currently in the digitization queue:
+
+```
+irb> require 'rsbe/client'
+irb> response = Rsbe::Client::Se.search(phase: 'digitization',
+                                        step:  'digitization',
+                                        status: 'queued')
+ => #<Faraday::Response:0x007fdc81b257b8 ...>
+
+irb> search_results = Rsbe::Client::SearchResults.new(response)
+ => #<Rsbe::Client::SearchResults:0x007fdc81b15660 ...>
+
+irb> search_results.success?
+ => true
+
+# NOTE:
+# this is fast because it just returns the num_found value
+#   from the Search response  
+#  
+irb> search_results.num_found
+ => 920
+
+# NOTE:
+# this operation may be slow. Calling Rsbe::Client::SearchResults#results
+#   instantiates an Se object for every record returned by the search.  
+#   Subsequent invocations of #results will be fast, however, because the
+#   Se objects are memoized.
+#
+irb> search_results.results[0..10].each {|se| puts "#{se.digi_id}"}
+foo_quux_cuid0
+foo_quux_cuid01234
+foo_quux_cuid1
+foo_quux_cuid10
+foo_quux_cuid100
+foo_quux_cuid101
+foo_quux_cuid102
+foo_quux_cuid103
+foo_quux_cuid104
+foo_quux_cuid105
+foo_quux_cuid106
+
+```

data/lib/rsbe/client/version.rb

@@ -1,5 +1,5 @@
 module Rsbe
   module Client
-    VERSION = "0.5.0"
+    VERSION = "0.5.1"
   end
 end

data/rsbe-client.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 2.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.5.0"
   spec.add_development_dependency "rspec-its", "~> 1.0.1"
@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.10.1"
 
   spec.add_dependency "faraday", "~> 0.9.0"
-  spec.add_dependency "activesupport", "~> 4.1.6"
+  spec.add_dependency "activesupport", "~> 4.2.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsbe-client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - jgpawletko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-07 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.6
+        version: 4.2.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.6
+        version: 4.2.11
 description: 
 email:
 - jgpawletko@gmail.com
@@ -151,6 +151,7 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- examples.md
 - lib/rsbe/client.rb
 - lib/rsbe/client/base.rb
 - lib/rsbe/client/collection.rb
@@ -242,8 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Client library for interacting with rsbe API.