collectionspace-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 624c2100ab4de83a3748eea7ec37a0fd4743cdda9365e8ccd29d452b11f0b8ad
-  data.tar.gz: 7f25d8c31ad74c28999de4bb5c5822f655f947154828174a3351d818e036a5f1
+  metadata.gz: e63c182e9731f5868556d805eed65b8c85d32789363c90f4ac763cff06e2b693
+  data.tar.gz: 00d6e5804a0131adad73d28eee0dd32a95dd9b9a05346bf4e1374d54bfa1f2b5
 SHA512:
-  metadata.gz: d65eaf040bb629d702085af054b47b2f39411784c0f8f7cdb032f48af79f99b846ef1f803ef357634d477f4b4d7c9f585e07c1d5b5e9476f22247b67ae0cd00c
-  data.tar.gz: 0661b69f11ea60a5ce5edc94f753a048a7ec6ce2585c855c69af25e4cfb1998106a13132e42fdbe8b70a5184a6032c817650253ebf215930a83ba7e1dd73a42d
+  metadata.gz: fa76fc6c2b8f1761c01dc195198445eba31698d0d530d0993c5fa64ceb1ace2fbc44153a7d8c4dd29fe3d272463e1f82d3185f5a8d46ddfbec9252f0b8ec0ca5
+  data.tar.gz: b67294a65c42c52804af6e429f45e2ea9bcb1a5e4ea4d78fb3da0cfeafb8018221d835a29b81c48fea6e43b287b88e549e6bfd746f124a9814c1079fdae3abc7

data/README.md

@@ -37,7 +37,7 @@ bundle exec rake
 Bump version in `lib/collectionspace/client/version.rb` then:
 
 ```bash
-VERSION=0.2.0
+VERSION=0.3.0
 git add .
 git commit -m "Bump version: v${VERSION}"
 git push origin master

data/examples/demo.rb

@@ -9,14 +9,12 @@ client = CollectionSpace::Client.new(
     password: 'Administrator'
   )
 )
-client.config.throttle = 1
 
 # GET REQUEST FOR CONDITIONCHECK RECORDS AND PRINT THE PARSED RESPONSE AND XML
 response = client.get('conditionchecks')
 ap response.parsed if response.result.success?
 
-# GET ALL INTAKE RECORDS AND PROCESS PER PAGE (INSTEAD OF WAITING FOR ALL)
-client.all('personauthorities').each do |item|
-  i = client.get item['uri']
-  ap i.parsed
+# GET ALL PERSON RECORDS AND PROCESS PER PAGE (INSTEAD OF WAITING FOR ALL)
+client.all('personauthorities/urn:cspace:name(person)/items').each do |item|
+  puts item
 end

data/examples/update_password.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'awesome_print'
+require 'base64'
+require 'collectionspace/client'
+
+CS_CFG_URL  = ENV.fetch('CS_CFG_URL', 'https://core.dev.collectionspace.org/cspace-services')
+CS_CFG_USER = ENV.fetch('CS_CFG_USER', 'admin@core.collectionspace.org')
+CS_CFG_PASS = ENV.fetch('CS_CFG_PASS', 'Administrator')
+CS_UPD_USER = ENV.fetch('CS_UPD_USER', 'admin@core.collectionspace.org')
+CS_UPD_PASS = Base64.encode64(ENV.fetch('CS_UPD_PASS', 'Administrator')).chomp
+
+client = CollectionSpace::Client.new(
+  CollectionSpace::Configuration.new(
+    base_uri: CS_CFG_URL,
+    username: CS_CFG_USER,
+    password: CS_CFG_PASS
+  )
+)
+
+PAYLOAD = <<~XML
+  <ns2:accounts_common xmlns:ns2="http://collectionspace.org/services/account">
+      <userId>#{CS_UPD_USER}</userId>
+      <password>#{CS_UPD_PASS}</password>
+  </ns2:accounts_common>
+XML
+
+client.all('accounts').each do |item|
+  next unless item['email'] == CS_UPD_USER
+
+  ap client.put(item['uri'], PAYLOAD).parsed
+end

data/lib/collectionspace/client/helpers.rb

@@ -4,37 +4,34 @@ module CollectionSpace
     # get ALL records at path by paging through record set
     def all(path, options = {})
       list_type, list_item = get_list_types(path)
-      Enumerator.new do |yielder|
-        page = 0
-        loop do
-          response = request('GET', path, options.merge(query: { pgNum: page }))
-          unless response.result.success?
-            raise CollectionSpace::RequestError, response.result.body
-          end
+      iterations = (count(path).to_f / config.page_size).ceil
+      return [] unless iterations.positive?
 
-          items = response.parsed[list_type].fetch('itemsInPage', 0).to_i
-          raise StopIteration if items.zero?
-
-          list_items = response.parsed[list_type][list_item]
-          list_items = [list_items] if items == 1
-          list_items.each { |item| yielder << item }
-          page += 1
+      Enumerator::Lazy.new(0...iterations) do |yielder, i|
+        response = request('GET', path, options.merge(query: { pgNum: i }))
+        unless response.result.success?
+          raise CollectionSpace::RequestError, response.result.body
         end
-      end.lazy
+
+        items_in_page = response.parsed[list_type].fetch('itemsInPage', 0).to_i
+        list_items = items_in_page.positive? ? response.parsed[list_type][list_item] : []
+        list_items = [list_items] if items_in_page == 1
+
+        yielder << list_items.shift until list_items.empty?
+      end
     end
 
     def count(path)
       list_type, = get_list_types(path)
-      response   = request('GET', path, query: { pgSz: 1 })
+      response   = request('GET', path, query: { pgNum: 0, pgSz: 1 })
       response.parsed[list_type]['totalItems'].to_i if response.result.success?
     end
 
     def get_list_types(path)
-      if path == 'relations'
-        %w[relations_common_list relation_list_item]
-      else
-        %w[abstract_common_list list_item]
-      end
+      {
+        'accounts' => %w[accounts_common_list account_list_item],
+        'relations' => %w[relations_common_list relation_list_item],
+      }.fetch(path, %w[abstract_common_list list_item])
     end
 
     def prepare_query(query, options = {})

data/lib/collectionspace/client/version.rb

@@ -1,5 +1,5 @@
 module CollectionSpace
   class Client
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collectionspace-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Cooper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2020-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -170,6 +170,7 @@ files:
 - examples/media_with_external_file.rb
 - examples/purge_empty_vocabs.rb
 - examples/search.rb
+- examples/update_password.rb
 - lib/collectionspace/client.rb
 - lib/collectionspace/client/client.rb
 - lib/collectionspace/client/configuration.rb
@@ -197,8 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: CollectionSpace API client.