plone_rest_api 0.8.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5aeaf06c586ef2e3f935276a3a2fe99f9f0963bed0acd22b8e27a81f33e77b6
+  data.tar.gz: 27706b04dd799999109705e55086ac3e8fb2eda390a5b7094b86d8795ab9d9ec
+SHA512:
+  metadata.gz: 318503f0ee4d4ff7a5e00b709ee0cc651a7489b12438d95a36f05dfb1464972bf567872704131caec03f3f2316a3b1d90d6beffd2d8721a4417fc7bf96ecf8cb
+  data.tar.gz: 359b4ce1b4f59edabd87b6ee1fdfae24fc1fe48bd99049dc09006231b24baefae5b855f9069e1e362cb58024352b8ba39fa298d21f549856ab4868f96c96cd44

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore auto-generated main file
+/main
+
+# Ignore Gemfile.lock. See https://stackoverflow.com/questions/4151495/should-gemfile-lock-be-included-in-gitignore
+/Gemfile.lock
+
+# Put your personal ignore files in /home/clr/.config/git/ignore
+.*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/ABOUT.md

@@ -0,0 +1,3 @@
+
+Wrapper around the Plone REST api for Ruby
+

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in plone_rest_api.gemspec
+gemspec

data/README.md

@@ -0,0 +1,33 @@
+# PloneRestApi
+
+Plone REST API. Can both be used as a library by requiring 'plone_rest_api' or as a command: plone-rest
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'plone_rest_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install plone_rest_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/plone_rest_api.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "plone_rest_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/plone-rest

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+require 'plone_rest_api.rb'
+
+require 'shellopts'
+
+USAGE = "u,user=ADMIN-USER p,password=ADMIN-PASSWORD s,site=SITE_URL version h,help create-user! read-user! update-user-password! delete-user! exist-user! list-users! create-group! read-group! update-group-add-user! update-group-remove-user! delete-group! exist-group! list-groups!"
+
+user=nil
+password=nil
+site = nil
+cmd = nil
+
+cmds = [
+  [ "create-user", :create_user, "USERNAME PASSWORD FULLNAME EMAIL" ],
+  [ "read-user", :read_user, "USERNAME" ],
+  [ "update-user-password", :update_user_password, "USERNAME OLD_PASSWORD NEW_PASSWORD" ],
+  [ "delete-user", :delete_user, "USERNAME" ],
+  [ "exist-user", :exist_user, "USERNAME" ],
+  [ "list-users", :list_users, "" ],
+
+  [ "create-group", :create_group, "GROUPNAME TITLE" ],
+  [ "read-group", :read_group, "GROUPNAME" ],
+  [ "update-group-add-user", :update_group_add_user, "GROUPNAME USERNAME" ],
+  [ "update-group-remove-user", :update_group_remove_user, "GROUPNAME USERNAME" ],
+  [ "delete-group", :delete_group, "GROUPNAME" ],
+  [ "exist-group", :exist_group, "GROUPNAME" ],
+  [ "list-groups", :list_groups, "" ]
+].map { |name, method, msg| [name, [method, msg]] }.to_h
+
+args = ShellOpts::process(USAGE, ARGV) { |opt, arg|
+  case opt
+    when "-u", "--user"; user = arg
+    when "-p", "--password"; password = arg
+    when "-s", "--site"; site = arg
+    when "--version"; puts PloneRestApi::VERSION; exit
+    when "-h", "--help"
+      puts "Usage:"
+      puts "  #{PROGRAM} --user=ADMIN-USER --password=ADMIN-PASSWORD --site=URL --version --help COMMAND"
+      puts "Commands:"
+      cmds.each { |cmd,v|
+        puts "  #{cmd} #{v.last}"
+      }
+      exit
+    when /[^-].*/; cmd = opt
+  else
+    raise "Oops: #{opt}"
+  end
+}
+
+# FIXME
+#user = "ras"
+#password = "tre109"
+#site = "http://portal.vbox.veda.lan"
+#site = "http://localhost:8080"
+
+!cmd.nil? or ShellOpts::error "Missing command"
+cmds.key?(cmd) or ShellOpts::error "Illegal command: #{cmd}"
+!site.nil? or ShellOpts::error "Missing site URL"
+if cmd != "update-user-password"
+  !user.nil? or ShellOpts::error "Missing administrative user name"
+  !password.nil? or ShellOpts::error "Missing administrative password"
+end
+
+api = PloneRestApi::Site.new(site, user, password)
+
+method, msg, size = cmds[cmd]
+size ||= msg.split.size
+if args.size != size
+  $stderr.puts "#{PROGRAM}: Illegal number of arguments"
+  $stderr.puts "Usage: #{PROGRAM} #{cmd} #{msg}"
+  exit(1)
+end
+
+begin
+  puts api.send(method, *args)
+rescue PloneRestApi::SubmitError => ex
+  $stderr.puts ex.long_message
+  exit 1
+end
+

data/lib/plone_rest_api/version.rb

@@ -0,0 +1,3 @@
+module PloneRestApi
+  VERSION = "0.8.4"
+end

data/lib/plone_rest_api.rb

@@ -0,0 +1,191 @@
+require "plone_rest_api/version"
+
+require 'json'
+require 'faraday'
+require 'rack/utils'
+
+module PloneRestApi
+  class Site
+    Credentials = Struct.new(:login, :password)
+
+    DEFAULT_RETRIES = 0
+    BATCH_SIZE = 100
+
+    attr_reader :url
+    
+    # Create a Plone REST API handle. The url is the base-url of the Plone
+    # site. The login should have Manager rights to be able to use all methods.
+    # The :retries option is the number of times to retry in case of timeouts
+    # (default: 0)
+    def initialize(url, login, password, retries: DEFAULT_RETRIES)
+      @url = url
+      @credentials = Credentials.new(login, password)
+      @retries = retries
+      @conn = Faraday.new(
+        url: @url,
+        headers: {
+          'Content-Type': 'application/json', 
+          'Accept': 'application/json',
+          'User-Agent': 'Plone REST API'
+        }
+      )
+    end
+
+    # Create a new group. Returns the user hash
+    def create_user(username, password, fullname, email)
+      data = { username: username, password: password, fullname: fullname, email: email }
+      submit(:post, "@users", 201, data: data)
+    end
+
+    # Return the user hash for the given username or nil if the user doesn't
+    # exist and :ignore_not_found is true
+    def read_user(username, ignore_not_found: false)
+      begin
+        submit(:get, "@users/#{username}", 200)
+      rescue SubmitError => ex
+        return nil if ex.status == 404 && ignore_not_found
+        raise
+      end
+    end
+
+    # Return array of user hashes
+    def list_users
+      submit(:get, "@users", 200)
+    end
+
+    # Return true if user exists
+    def exist_user(username)
+      !read_user(username, ignore_not_found: true).nil?
+    end
+
+    # Update user and return true if successful
+    def update_user(username, update)
+      data = update
+      submit(:patch, "@users/#{username}", 204, data: data)
+    end
+
+    # Update user's password. Returns true
+    def update_user_password(username, old_password, new_password)
+      credentials = Credentials.new(username, old_password)
+      data = { old_password: old_password, new_password: new_password }
+      submit(:post, "@users/#{username}/reset-password", 200, data: data, credentials: credentials)
+    end
+
+    # Delete a user. Returns true if successful, but nil if the user doesn't
+    # exist and :ignore_not_found is true
+    def delete_user(username, ignore_not_found: false)
+      begin
+        submit(:delete, "@users/#{username}", 204)
+      rescue SubmitError => ex
+        return true if ex.status == 404 && ignore_not_found
+        raise
+      end
+    end
+
+    # Create a new group. Returns the group hash
+    def create_group(groupname, title)
+      data = { groupname: groupname, title: title }
+      submit(:post, "@groups", 201, data: data)
+    end
+
+    # Return the group hash for the given groupname or nil if the group doesn't
+    # exist and :ignore_not_found is true
+    def read_group(groupname, ignore_not_found: false)
+      items = []
+      begin
+        reply = submit(:get, "@groups/#{groupname}?b_size=#{BATCH_SIZE}", 200)
+        items = reply["users"]["items"]
+        if reply["users"]["batching"]
+          while next_url = reply["users"]["batching"]["next"]
+            reply = submit(:get, "#{next_url}&b_size=#{BATCH_SIZE}", 200)
+            items += reply["users"]["items"]
+          end
+          items.size == reply["users"]["items_total"] or raise Error.new "Failed batch-fetching items"
+          reply["users"]["batching"] = {} # Helps testing to leave the key instead of removing it
+          reply["users"]["items"] = items
+        end
+        reply
+      rescue SubmitError => ex
+        return nil if ex.status == 404 && ignore_not_found
+        raise
+      end
+    end
+
+    # Return array of group hashes
+    def list_groups
+      submit(:get, "@groups", 200)
+    end
+
+    # Return true if group exists
+    def exist_group(groupname)
+      !read_group(groupname, ignore_not_found: true).nil?
+    end
+
+    # Add a user to a group. Returns true
+    def update_group_add_user(groupname, username)
+      data = { "users": { username => true } }
+      submit(:patch, "@groups/#{groupname}", 204, data: data)
+    end
+
+    # Remove a user from a group. Returns true
+    def update_group_remove_user(groupname, username)
+      data = { "users": { username => false } }
+      submit(:patch, "@groups/#{groupname}", 204, data: data)
+    end
+
+    # Delete a group. Returns true or nil if the group doesn't exist and
+    # :ignore_not_found is true
+    def delete_group(groupname, ignore_not_found: false)
+      begin
+        submit(:delete, "@groups/#{groupname}", 204)
+      rescue SubmitError => ex
+        return true if ex.status == 404 && ignore_not_found
+        raise
+      end
+    end
+
+  private
+    def submit(verb, resource, expected_status, data: nil, credentials: @credentials)
+      begin
+        attempts ||= @retries + 1
+        resp = @conn.send(verb, resource) { |req|
+          req.headers["Authorization"] = 
+              Faraday::Request::BasicAuthentication.header(credentials.login, credentials.password)
+          req.body = data.to_json if data
+        }
+      rescue Faraday::TimeoutError => ex
+        retry if (attempts -= 1) > 0
+        raise TimeoutError.new(ex.message)
+      end
+        
+      resp.status == expected_status or begin
+        if resp.body && !resp.body.empty?
+          json = JSON.load(resp.body)
+          message = json.is_a?(Hash) ? json["message"] : nil
+        else
+          message = nil
+        end
+        raise SubmitError.new(resp.status, message)
+      end
+      resp.body && !resp.body.empty? && JSON.load(resp.body) || true
+    end
+  end
+
+  class Error < StandardError
+    def short_message() message end
+    def long_message() message end
+  end
+
+  class TimeoutError < Error; end
+
+  class SubmitError < Error
+    attr_accessor :status, :short_message, :long_message
+    def initialize(status, message = nil)
+      @status = status
+      @short_message = "#{@status} #{Rack::Utils::HTTP_STATUS_CODES[status]}"
+      @long_message =  @short_message + (message && message != "" ? " - #{message}" : "")
+      super(message || @short_message)
+    end
+  end
+end
+

data/plone_rest_api.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "plone_rest_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "plone_rest_api"
+  spec.version       = PloneRestApi::VERSION
+  spec.authors       = ["Claus Rasmussen"]
+  spec.email         = ["ras@danak.dk"]
+
+  spec.summary       = %q{Plone REST api library and command}
+  spec.description   = %q{Plone REST api library and command}
+  spec.homepage      = "http://www.nowhere.com/"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+# if spec.respond_to?(:metadata)
+#   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+#
+#   spec.metadata["homepage_uri"] = spec.homepage
+#   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+#   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+# else
+#   raise "RubyGems 2.0 or newer is required to protect against " \
+#     "public gem pushes."
+# end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "shellopts", "= 0.9.5"
+  spec.add_dependency "faraday"
+  spec.add_dependency "rack"
+  spec.add_dependency "pg"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: plone_rest_api
+version: !ruby/object:Gem::Version
+  version: 0.8.4
+platform: ruby
+authors:
+- Claus Rasmussen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shellopts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Plone REST api library and command
+email:
+- ras@danak.dk
+executables:
+- plone-rest
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- ABOUT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/plone-rest
+- lib/plone_rest_api.rb
+- lib/plone_rest_api/version.rb
+- plone_rest_api.gemspec
+homepage: http://www.nowhere.com/
+licenses: []
+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: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Plone REST api library and command
+test_files: []