figshare_api_v2 0.9.6 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a7584ac8d8eb3bd0c1750eccfd3568eef74781b1bb3c5d3c3cce12fe17affab
-  data.tar.gz: 3d10aed08ec5bbb2b4f9534510e478d70c4ec3f20b2674e073c33249d9e6b56e
+  metadata.gz: a86e2853e1c2c18bf91ac4c3bd5052969bdf6924ea5fb3c7e89c47e6b3269c17
+  data.tar.gz: 4a27f7e8c20b0e9bbdc6227b7f0a0d85ab68f66e8ff8870c9d62754976dddc12
 SHA512:
-  metadata.gz: 141ffdc6d2487e5febd08fd547f2836efadd0b3d55907ba9e025f61846efed48c6e8382c52c0729b85093c5916a5c9569f5fa1adcc08d8650ef132f450ddc46f
-  data.tar.gz: cf73c9713e16b66e782ef79246a8f7422166d8ae8f06318d34f9fff2bd8bd517af9b1116050604c4ce4e58841b62590f87f4706384578f0f0b808726bc7d3373
+  metadata.gz: dc319835c9ce246e14d9b221bff575af8aa05b70e782b12d674b17f858ff2cfd309f1535ca0e371dea3f5ce23b33d26d64721dd786eb2085cde995aa213d370d
+  data.tar.gz: '01970e2696c5a5f969463d38446a7a658e12f0e8cabad2704fc5fb00202058891ef7748d5993540e7da24da6ebea4081f8322917493141bd491329608c98800a'

data/History.txt

@@ -1,3 +1,11 @@
+robertburrowes	Tue Nov 2 13:12:30 2021 +1300
+	Saner initialization option :)
+robertburrowes	Tue Sep 21 13:03:44 2021 +1200
+	Experimenting with fetching user accounts. Finding a 9000 limit on the total responses, resulting in odd differences in the numbers between  fetching everyone, just active, and just inactive accounts. None of which match using the figshare admin web pages
+robertburrowes	Tue Sep 21 13:01:16 2021 +1200
+	Rubocop'd
+robertburrowes	Tue Sep 21 13:00:57 2021 +1200
+	Rubocop'd Added chdir, so Atom starts in the right dir
 robertburrowes	Mon Sep 20 12:31:26 2021 +1200
 	Test for listing all institutional accounts, and getting individual account quota.
 robertburrowes	Mon Sep 20 12:30:34 2021 +1200

data/lib/base.rb

@@ -13,12 +13,19 @@ module Figshare
     # Opens a connection to the LDAP server, setting @ldap for other methods to use.
     #
     # @param figshare_user [String] figshare user, in the figshare_keys.json
-    # @param conf_dir [String] directory for figshare_keys.json and figshare_site_params.json
-    def initialize(figshare_user:, conf_dir:)
-      figshare_token = load_json_file("#{conf_dir}/figshare_keys.json")
+    # @param conf_dir [String|nil] directory for figshare_keys.json and figshare_site_params.json
+    # @param key_file [String|nil] conf_dir/figshare_keys.json if nil
+    # @param conf_file [String|nil] conf_dir/figshare_site_params.json if nil
+    def initialize(figshare_user:, conf_dir: nil, key_file: nil, conf_file: nil)
+      raise 'Figshare_api_v2.initialize: Need to specify the conf_dir if key_file or conf_file are nil' if conf_dir.nil? && (key_file.nil? || conf_file.nil?)
+
+      conf_file ||= "#{conf_dir}/figshare_site_params.json"
+      key_file ||= "#{conf_dir}/figshare_keys.json"
+
+      figshare_token = load_json_file(key_file)
       @auth_token = figshare_token[figshare_user]
 
-      figshare_site_params = load_json_file("#{conf_dir}/figshare_site_params.json")
+      figshare_site_params = load_json_file(conf_file)
 
       @hostname = figshare_site_params['host']
       @api_url = figshare_site_params['api_url']

data/lib/figshare_api_v2.rb

@@ -1,7 +1,7 @@
 module Figshare # :nodoc:
   # Figshare module initialization
   #
-  VERSION = '0.9.6'
+  VERSION = '0.9.7'
 
   require 'wikk_webbrowser'
   require 'wikk_json'
@@ -33,94 +33,98 @@ module Figshare # :nodoc:
     # Intitialize the Init class, so it can dynamically initialize the Figshare subclasses
     #
     # @param figshare_user [String] figshare user, in the figshare_keys.json
-    # @param conf_dir [String] directory for figshare_keys.json and figshare_site_params.json
-    def initialize(figshare_user:, conf_dir:)
+    # @param conf_dir [String|nil] directory for figshare_keys.json and figshare_site_params.json
+    # @param key_file [String|nil] conf_dir/figshare_keys.json if nil
+    # @param conf_file [String|nil] conf_dir/figshare_site_params.json if nil
+    def initialize(figshare_user:, conf_dir: nil, key_file: nil, conf_file: nil)
       @figshare_user = figshare_user
       @conf_dir = conf_dir
+      @key_file = key_file
+      @conf_file = conf_file
     end
 
     # Create Figshare::Authors, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::Authors]
     def authors
-      @authors ||= Authors.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @authors ||= Authors.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::Institutions, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::Institutions]
     def institutions
-      @institutions ||= Institutions.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @institutions ||= Institutions.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::Other, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::Other]
     def other
-      @other ||= Other.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @other ||= Other.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::PrivateArticles, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PrivateArticles]
     def private_articles
-      @private_articles ||= PrivateArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @private_articles ||= PrivateArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::PrivateCollections, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PrivateCollections]
     def private_collections
-      @private_collections ||= PrivateCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @private_collections ||= PrivateCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::PrivateProjects, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PrivateProjects]
     def private_projects
-      @private_projects ||= PrivateProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @private_projects ||= PrivateProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::PublicArticles, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PublicArticles]
     def public_articles
-      @public_articles ||= PublicArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @public_articles ||= PublicArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::PublicCollections, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PublicCollections]
     def public_collections
-      @public_collections ||= PublicCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @public_collections ||= PublicCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::PublicProjects, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PublicProjects]
     def public_projects
-      @public_projects ||= PublicProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @public_projects ||= PublicProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::Upload, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::Upload]
     def upload
-      @upload ||= Upload.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @upload ||= Upload.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::Stats, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::Stats]
     def stats
-      @stats ||= Stats.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @stats ||= Stats.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::OAI_PMH, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::OAI_PMH]
     def oai_pmh
-      @oai_pmh ||= OAI_PMH.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @oai_pmh ||= OAI_PMH.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
   end
 end

data/lib/stats.rb

@@ -4,13 +4,17 @@ module Figshare
   class Stats
     def breakdown
     end
+
     def timeline
     end
+
     def tops
     end
+
     def totals
     end
+
     def count
     end
-  end #class
-end # module
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: figshare_api_v2
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors:
 - Rob Burrowes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-20 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wikk_json
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Figshare version 2 API.