fog-cloudian 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16ef943c1d327ad55cbb69280b6abb13e756dcc329be6996cc5bdd29701b2710
+  data.tar.gz: b049896da6f7a8f1e41639b6d963e231f16e4cefa14ba75698506745d6fa2d67
+SHA512:
+  metadata.gz: 69199d7b46d9108244bc2b1f13b1b9345ced6b3dca460f2e192e4677c59f3eb90a8ab5ec607255bcffe1132c28f857f4d6e2dd3e92fb27c781ab7b55a292149c
+  data.tar.gz: e07d813b432a93f111fa5c65ade1967433535b3832e42b4dc8fae70b69f264260994096ce2bac2e6ccedf6f1857c71105296e76227c54e474d4d3b605b44e046

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.ruby-version

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

data/.travis.yml

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

data/CONTRIBUTORS.md

@@ -0,0 +1 @@
+* Phil Hofmann <phil@200ok.ch>

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fog-cloudian.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    fog-cloudian (0.1.0)
+      fog-aws (~> 3.5.2)
+      fog-core (~> 2.1)
+      fog-json (~> 1.1)
+      ipaddress (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.4)
+    diff-lcs (1.3)
+    excon (0.71.1)
+    fog-aws (3.5.2)
+      fog-core (~> 2.1)
+      fog-json (~> 1.1)
+      fog-xml (~> 0.1)
+      ipaddress (~> 0.8)
+    fog-core (2.2.0)
+      builder
+      excon (~> 0.71)
+      formatador (~> 0.2)
+      mime-types
+    fog-json (1.2.0)
+      fog-core
+      multi_json (~> 1.10)
+    fog-xml (0.1.3)
+      fog-core
+      nokogiri (>= 1.5.11, < 2.0.0)
+    formatador (0.2.5)
+    ipaddress (0.8.3)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    mini_portile2 (2.4.0)
+    multi_json (1.14.1)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  fog-cloudian!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 [[CONTRIBUTORS.md]]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Fog::Cloudian
+
+
+This is a Fog API wrapper for the Cloudian Hyperstore REST APIs (Admin
+& S3). For S3 this is just a shim for fog-aws.
+
+Currently about 13% (10 out of 77 API calls) of the Admin API are
+covered. Hence there is plenty of opportunity for some FOSS
+contribution here.
+
+Also this library does not provide proper mock requests, yet. Which
+means more opportunities to get you feet wet. ;)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'fog-cloudian'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install fog-cloudian
+```
+
+## Usage
+
+Before you can use fog-cloudian, you must require it in your application:
+
+```ruby
+require  'fog/cloudian'
+```
+
+### Connecting to Cloudian's Admin API
+
+```ruby
+config = {
+    user: '[REDACTED]',
+    password: '[REDACTED]',
+    host: '[REDACTED]',
+    port: 19443,
+    ssl_verify_peer: true
+}
+
+cloudian = Fog::Cloudian::Admin.new(config)
+```
+
+You can review all the requests available with this service using #requests method:
+
+```ruby
+cloudian.requests # => [[nil, :create_group], [nil, :get_group], [nil, :delete_group], ...
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/200ok-ch/fog-cloudian/fork )
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request
+
+## License
+
+see [LICENSE.md](LICENSE.md)

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 "fog/cloudian"
+
+# 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/fog-cloudian.gemspec

@@ -0,0 +1,46 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fog/cloudian/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fog-cloudian'
+  spec.version       = Fog::Cloudian::VERSION
+  spec.authors       = ['Phil Hofmann']
+  spec.email         = ['phil@200ok.ch']
+
+  spec.summary       = %q{Fog API wrapper for the Cloudian Hyperstore REST APIs}
+  spec.description   = %q{Fog API wrapper for the Cloudian Hyperstore REST APIs}
+  spec.homepage      = 'https://github.com/200ok-ch/fog-cloudian'
+
+  # # 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 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'fog-aws', '~> 3.5.2'
+  spec.add_dependency 'fog-core',  '~> 2.1'
+  spec.add_dependency 'fog-json',  '~> 1.1'
+  # spec.add_dependency 'fog-xml',   '~> 0.1'
+  spec.add_dependency 'ipaddress', '~> 0.8'
+end

data/lib/fog-cloudian.rb

@@ -0,0 +1 @@
+require 'fog/cloudian'

data/lib/fog/cloudian.rb

@@ -0,0 +1,22 @@
+require 'fog/core'
+require 'fog/xml'
+require 'fog/json'
+
+require File.expand_path("../cloudian/version", __FILE__)
+
+$:.unshift(File.dirname(__FILE__))
+
+module Fog
+  module Cloudian
+    extend Fog::Provider
+
+    autoload :Admin, File.expand_path('../cloudian/admin', __FILE__)
+    autoload :Storage, File.expand_path('../cloudian/storage', __FILE__)
+
+    service(:admin, 'Admin')
+    service(:storage, 'Storage')
+
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/fog/cloudian/admin.rb

@@ -0,0 +1,87 @@
+module Fog
+  module Cloudian
+    class Admin < Fog::Service
+
+      requires :user, :password
+      recognizes :host, :port, :path, :persistent, :ssl_verify_peer
+
+      request_path 'fog/cloudian/requests/admin'
+
+      # group
+      request :create_group
+      request :get_group
+      request :delete_group
+
+      # user
+      request :create_user
+      request :get_user
+      request :update_user
+      request :delete_user
+      request :set_password
+      request :create_credentials
+
+      # qos
+      request :set_qos_limits
+
+      # model_path 'fog/cloudian/models/admin'
+      # model       :group
+      # collection  :groups
+      # model       :user
+      # collection  :users
+
+      def initialize(options={})
+        @options = options
+      end
+
+      class Real
+        def initialize(options={})
+          @user = options[:user]
+          @password = options[:password]
+
+          @host = options[:host]
+          @port = options[:port]
+          @path = options[:path] || '/'
+          @persistent = options[:persistent] || false
+          @ssl_verify_peer = true if options[:ssl_verify_peer] != false
+
+          url = "https://#{@host}:#{@port}#{@path}"
+          params = { user: @user,
+                     password: @password,
+                     # NOTE: cloudians error messages always seem to be HTML
+                     headers: {"Accept" => "application/json"},
+                     ssl_verify_peer: @ssl_verify_peer }
+          @connection = Fog::Core::Connection.new(url, @persistent, params)
+        end
+
+        def request(method, path, payload, query=nil)
+          # NOTE: on success cloudian always returns a 200, they don't
+          # know any other status codes, nor redirects
+          params = { method: method, path: path, expects: [200] }
+          params[:body] = Fog::JSON.encode(payload) if payload
+          params[:query] = query if query
+
+          response = @connection.request(params)
+
+          if response.body.empty?
+            :success_with_empty_body
+          else
+            case response.headers['Content-Type']
+            when /^application\/json/
+              # puts response.body
+              Fog::JSON.decode(response.body)
+            else
+              response.headers['Content-Type']
+            end
+          end
+          # rescue Excon::Errors::HTTPStatusError => error
+          #   error
+        end
+      end
+
+      class Mock
+        def initialize(options={})
+        end
+      end
+    end
+  end
+end

data/lib/fog/cloudian/requests/admin/create_credentials.rb

@@ -0,0 +1,13 @@
+module Fog
+  module Cloudian
+    class Admin
+      class Real
+        def create_credentials(user_name, group_name)
+          request(:put, 'user/credentials', nil, { userId: user_name,
+                                                   groupId: group_name })
+          # this returns "credentials object" in JSON
+        end
+      end
+    end
+  end
+end

data/lib/fog/cloudian/requests/admin/create_group.rb

@@ -0,0 +1,12 @@
+module Fog
+  module Cloudian
+    class Admin
+      class Real
+        def create_group(group_name)
+          request(:put, 'group', { groupId: group_name })
+          # NOTE: the response is a 200 and has an empty body *sigh*
+        end
+      end
+    end
+  end
+end

data/lib/fog/cloudian/requests/admin/create_user.rb

@@ -0,0 +1,14 @@
+module Fog
+  module Cloudian
+    class Admin
+      class Real
+        def create_user(user_name, group_name, user_type='User')
+          request(:put, 'user', { userId: user_name,
+                                  groupId: group_name,
+                                  userType: user_type })
+          # this returns a "user object" as JSON
+        end
+      end
+    end
+  end
+end

data/lib/fog/cloudian/requests/admin/delete_group.rb

@@ -0,0 +1,12 @@
+module Fog
+  module Cloudian
+    class Admin
+      class Real
+        def delete_group(group_name)
+          request(:delete, 'group', nil, { groupId: group_name })
+          # the response is a 200 and has an empty body
+        end
+      end
+    end
+  end
+end

data/lib/fog/cloudian/requests/admin/delete_user.rb

@@ -0,0 +1,12 @@
+module Fog
+  module Cloudian
+    class Admin
+      class Real
+        def delete_user(user_name, group_name)
+          request(:delete, 'user', nil, { userId: user_name, groupId: group_name })
+          # the response is 200 with an empty body
+        end
+      end
+    end
+  end
+end

data/lib/fog/cloudian/requests/admin/get_group.rb

@@ -0,0 +1,12 @@
+module Fog
+  module Cloudian
+    class Admin
+      class Real
+        def get_group(group_name)
+          request(:get, 'group', nil, { groupId: group_name })
+          # this returns a "group object" in JSON
+        end
+      end
+    end
+  end
+end

data/lib/fog/cloudian/requests/admin/get_user.rb

@@ -0,0 +1,13 @@
+module Fog
+  module Cloudian
+    class Admin
+      class Real
+        def get_user(user_name, group_name)
+          request(:get, 'user', nil, { userId: user_name,
+                                       groupId: group_name })
+          # this returns an "user object" in JSON
+        end
+      end
+    end
+  end
+end

data/lib/fog/cloudian/requests/admin/set_password.rb

@@ -0,0 +1,30 @@
+module Fog
+  module Cloudian
+    class Admin
+      class Real
+        def set_password(user_name, group_name, password)
+          # POST /user/password Create or change a user's CMC password
+          #
+          # Minimum of nine characters, maximum of 64 characters
+          # Must contain at least three of these four types of characters:
+          #   o Lower case letters
+          #   o Upper case letters
+          #   o Numbers
+          #   o Special characters such as !, @, #, $, %, ^, etc.
+
+          request(:post, 'user/password', nil, { userId: user_name,
+                                                 groupId: group_name,
+                                                 password: password })
+
+          # This returns a 200 with an empty body.
+          #
+          # Unless the user does not exist then you'll get a...
+          #
+          #   "204 User does not exist"
+          #
+          # ROFLMAO.
+        end
+      end
+    end
+  end
+end

data/lib/fog/cloudian/requests/admin/set_qos_limits.rb

@@ -0,0 +1,29 @@
+module Fog
+  module Cloudian
+    class Admin
+      class Real
+
+        QOS_LIMITS_DEFAULTS = {
+          userId: '*', # TODO: maybe use 'ALL' instead
+          # groupId: '...', # required
+          storageQuotaKBytes: -1,
+          storageQuotaCount: -1,
+          wlRequestRate: -1,
+          hlRequestRate: -1,
+          wlDataKBytesIn: -1,
+          hlDataKBytesIn: -1,
+          wlDataKBytesOut: -1,
+          hlDataKBytesOut: -1
+        }
+
+        def set_qos_limits(qos_details)
+          raise 'groupId must be given' unless qos_details[:groupId]
+          details = QOS_LIMITS_DEFAULTS.merge(qos_details)
+          # POST /qos/limits Create QoS settings for a user or group
+          request(:post, 'qos/limits', nil, details)
+          # this returns a 200 with an empty body
+        end
+      end
+    end
+  end
+end

data/lib/fog/cloudian/requests/admin/update_user.rb

@@ -0,0 +1,18 @@
+module Fog
+  module Cloudian
+    class Admin
+      class Real
+        def update_user(user_details)
+          # The `user_details` must either have `canonicalUserId` XOR
+          # (`userId` AND `groupId`). @cloudian: What are you doing?
+          if user_details["canonicalUserId"]
+            user_details.delete("userId")
+            user_details.delete("groupId")
+          end
+
+          request(:post, 'user', user_details)
+        end
+      end
+    end
+  end
+end

data/lib/fog/cloudian/storage.rb

@@ -0,0 +1,13 @@
+require 'fog/aws'
+
+module Fog
+  module Cloudian
+
+    # this is just a shim, as cloudian provides a s3 compatible api
+    Storage = Fog::AWS::Storage
+
+    # If need be we could still repoen the class and override methods
+    # to account for any idiosyncracies.
+
+  end
+end

data/lib/fog/cloudian/version.rb

@@ -0,0 +1,5 @@
+module Fog
+  module Cloudian
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: fog-cloudian
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Phil Hofmann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fog-aws
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+- !ruby/object:Gem::Dependency
+  name: fog-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: fog-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Fog API wrapper for the Cloudian Hyperstore REST APIs
+email:
+- phil@200ok.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CONTRIBUTORS.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fog-cloudian.gemspec
+- lib/fog-cloudian.rb
+- lib/fog/cloudian.rb
+- lib/fog/cloudian/admin.rb
+- lib/fog/cloudian/requests/admin/create_credentials.rb
+- lib/fog/cloudian/requests/admin/create_group.rb
+- lib/fog/cloudian/requests/admin/create_user.rb
+- lib/fog/cloudian/requests/admin/delete_group.rb
+- lib/fog/cloudian/requests/admin/delete_user.rb
+- lib/fog/cloudian/requests/admin/get_group.rb
+- lib/fog/cloudian/requests/admin/get_user.rb
+- lib/fog/cloudian/requests/admin/set_password.rb
+- lib/fog/cloudian/requests/admin/set_qos_limits.rb
+- lib/fog/cloudian/requests/admin/update_user.rb
+- lib/fog/cloudian/storage.rb
+- lib/fog/cloudian/version.rb
+homepage: https://github.com/200ok-ch/fog-cloudian
+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.3
+signing_key: 
+specification_version: 4
+summary: Fog API wrapper for the Cloudian Hyperstore REST APIs
+test_files: []