brick_ftp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 763c13ebed0e36da20c18284f3a679314c991d6b
+  data.tar.gz: d04fbfdbfd3c579010d5880d0e755a0b65f156e7
+SHA512:
+  metadata.gz: 35aabedc78ef3f7c9af8574551705321be517eedd940b0b52a1dd3f59aedd9fca38893303d344167e5559f8bed684e31c7e09794d7a215368741dd19cc68bfe9
+  data.tar.gz: de4d25dd868eb8b1f8f90238ee30fc2d66062553841f931f141d4ea0aecc767f4adb73746b5409f3dbdcba55386e4be150789761634607db86742e194b7a2009

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Masataka Suzuki
+
+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,61 @@
+[![CircleCI](https://circleci.com/gh/koshigoe/brick_ftp/tree/master.svg?style=svg)](https://circleci.com/gh/koshigoe/brick_ftp/tree/master)
+
+# BrickFTP
+
+This is a [BrickFTP](https://brickftp.com/)'s _unofficial_ [REST API](https://brickftp.com/ja/docs/rest-api/) Client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brick_ftp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brick_ftp
+
+## Usage
+
+### Configuration
+
+```ruby
+BrickFTP.configure do |c|
+  c.subdomain = 'koshigoe'      # Used by build API URL(e.g. https://{subdomain}.brickftp.com/api/rest/v1/...)
+  c.api_key = 'xxxxx'           # Used by set REST API key.
+  c.logger = Logger.new(STDOUT) # Used by logging.
+end
+```
+
+- Environment value `BRICK_FTP_SUBDOMAIN` is set to `subdomain`.
+- Environment value `BRICK_FTP_API_KEY` is set to `api_key`.
+
+### Authentication
+
+If you authenticate by API key, you set API key to configuration.
+If you authenticate by session cooki, you must authenticate by API.
+
+```ruby
+# Authenticate and set authentication session to configuration.
+BrickFTP::API::Authentication.login('koshigoe', 'password')
+```
+
+### Other APIs
+
+see API document or source code.
+
+## 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]/brick_ftp.
+

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 "brick_ftp"
+
+# 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

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/brick_ftp.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brick_ftp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "brick_ftp"
+  spec.version       = BrickFTP::VERSION
+  spec.authors       = ["koshigoe"]
+  spec.email         = ["koshigoeb@gmail.com"]
+
+  spec.summary       = %q{BrickFTP's REST API client.}
+  spec.description   = %q{BrickFTP's REST API client.}
+  spec.homepage      = "https://github.com/koshigoe/brick_ftp"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+
+  spec.add_dependency 'deep_hash_transform', '~> 1.0'
+end

data/lib/brick_ftp.rb

@@ -0,0 +1,44 @@
+require 'deep_hash_transform'
+require "brick_ftp/version"
+require 'brick_ftp/configuration'
+require 'brick_ftp/http_client'
+require 'brick_ftp/api'
+require 'brick_ftp/api/base'
+require 'brick_ftp/api/authentication'
+require 'brick_ftp/api/authentication/session'
+require 'brick_ftp/api/user'
+require 'brick_ftp/api/public_key'
+require 'brick_ftp/api/group'
+require 'brick_ftp/api/permission'
+require 'brick_ftp/api/notification'
+require 'brick_ftp/api/history'
+require 'brick_ftp/api/history/site'
+require 'brick_ftp/api/history/login'
+require 'brick_ftp/api/history/user'
+require 'brick_ftp/api/history/folder'
+require 'brick_ftp/api/history/file'
+require 'brick_ftp/api/bundle'
+require 'brick_ftp/api/bundle_content'
+require 'brick_ftp/api/bundle_download'
+require 'brick_ftp/api/behavior'
+require 'brick_ftp/api/behavior_folder'
+require 'brick_ftp/api/folder'
+require 'brick_ftp/api/file'
+require 'brick_ftp/api/file_move'
+require 'brick_ftp/api/file_copy'
+require 'brick_ftp/api/file_upload'
+
+module BrickFTP
+  def self.config
+    @config ||= BrickFTP::Configuration.new
+  end
+
+  def self.config=(config)
+    raise TypeError unless config.is_a?(BrickFTP::Configuration)
+    @config = config
+  end
+
+  def self.configure
+    yield(config)
+  end
+end

data/lib/brick_ftp/api.rb

@@ -0,0 +1,4 @@
+module BrickFTP
+  module API
+  end
+end

data/lib/brick_ftp/api/authentication.rb

@@ -0,0 +1,21 @@
+require 'cgi'
+
+module BrickFTP
+  module API
+    module Authentication
+      COOKIE_NAME = 'BrickFTP'.freeze
+
+      def self.cookie(session)
+        CGI::Cookie.new(COOKIE_NAME, session.id)
+      end
+
+      def self.login(username, password)
+        Session.create(username: username, password: password)
+      end
+
+      def self.logout
+        BrickFTP.config.session.destroy
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/authentication/session.rb

@@ -0,0 +1,23 @@
+module BrickFTP
+  module API
+    module Authentication
+      class Session < BrickFTP::API::Base
+        define_api :create, '/api/rest/v1/sessions.json'
+        define_api :delete, '/api/rest/v1/sessions.json'
+        define_writable_attributes :username, :password
+        define_readonly_attributes :id
+
+        def self.create(params = {})
+          super.tap { |x| BrickFTP.config.session = x }
+        end
+
+        def destroy
+          super.tap do
+            @id = nil
+            BrickFTP.config.session = nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/base.rb

@@ -0,0 +1,111 @@
+require 'cgi'
+
+module BrickFTP
+  module API
+    class Base
+      class NoSuchAPIError < StandardError; end
+
+      class UndefinedAttributesError < StandardError
+        def initialize(undefined_attributes = [])
+          super "No such attributes: #{undefined_attributes.join(', ')}"
+        end
+      end
+
+      def self.inherited(subclass)
+        subclass.instance_eval do
+          @api = {}
+          @writable_attributes = []
+          @readonly_attributes = []
+        end
+      end
+
+      class << self
+        attr_reader :api, :writable_attributes, :readonly_attributes
+      end
+
+      def self.attributes
+        writable_attributes + readonly_attributes
+      end
+
+      def self.define_api(method, path)
+        @api[method] = path
+      end
+
+      def self.define_writable_attributes(*attributes)
+        @writable_attributes = attributes
+        attr_reader *@writable_attributes.map { |x| x.to_s.tr('-', '_') }
+      end
+
+      def self.define_readonly_attributes(*attributes)
+        @readonly_attributes = attributes
+        attr_reader *@readonly_attributes.map { |x| x.to_s.tr('-', '_') }
+      end
+
+      def self.api_path_for(method, params = {})
+        raise NoSuchAPIError, "#{method} #{self.name}" unless @api.key?(method)
+        @api[method] % Hash[params.map { |k, v| [k, CGI.escape(v.to_s)] }]
+      end
+
+      QUERY_PARAMS = %i(page per_page start_at recursive).freeze
+
+      def self.all(path_params = {})
+        path_params.symbolize_keys!
+        query_params = QUERY_PARAMS.each_with_object({}) do |name, res|
+          res.update(name => path_params.delete(name)) if path_params.key?(name)
+        end
+
+        path = api_path_for(:index, path_params)
+        unless query_params.empty?
+          query = query_params.each_with_object([]) do |(k, v), res|
+            res << "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+          end.join('&')
+          path = "#{path}?#{query}"
+        end
+
+        BrickFTP::HTTPClient.new.get(path).map { |x| new(x.symbolize_keys) }
+      end
+
+      def self.find(id)
+        params = {}
+        api[:show].scan(/%\{([^}]+)\}/) { |m| params[m.first.to_sym] = id }
+        data = BrickFTP::HTTPClient.new.get(api_path_for(:show, params))
+        data.empty? ? nil : new(data.symbolize_keys)
+      end
+
+      def self.create(params = {}, path_params = {})
+        params.symbolize_keys!
+        undefined_attributes = params.keys - writable_attributes
+        raise UndefinedAttributesError, undefined_attributes unless undefined_attributes.empty?
+
+        data = BrickFTP::HTTPClient.new.post(api_path_for(:create, path_params), params: params)
+        data = {} if data.is_a?(Array)
+        new(data.symbolize_keys)
+      end
+
+      def initialize(params = {})
+        undefined_attributes = params.keys - self.class.attributes
+        raise UndefinedAttributesError, undefined_attributes unless undefined_attributes.empty?
+
+        params.each { |k, v| instance_variable_set(:"@#{k}", v) }
+      end
+
+      def update(params = {})
+        params.symbolize_keys!
+        undefined_attributes = params.keys - self.class.writable_attributes
+        raise UndefinedAttributesError, undefined_attributes unless undefined_attributes.empty?
+
+        data = BrickFTP::HTTPClient.new.put(self.class.api_path_for(:update, id: id), params: params)
+        data.each { |k, v| instance_variable_set(:"@#{k}", v) }
+
+        self
+      end
+
+      def destroy
+        params = {}
+        self.class.api[:delete].scan(/%\{([^}]+)\}/) { |m| params[m.first.to_sym] = send(m.first.to_sym) }
+        BrickFTP::HTTPClient.new.delete(self.class.api_path_for(:delete, params))
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/behavior.rb

@@ -0,0 +1,13 @@
+module BrickFTP
+  module API
+    class Behavior < Base
+      define_api :index,  '/api/rest/v1/behaviors.json'
+      define_api :show,   '/api/rest/v1/behaviors/%{id}.json'
+      define_api :create, '/api/rest/v1/behaviors.json'
+      define_api :update, '/api/rest/v1/behaviors/%{id}.json'
+      define_api :delete, '/api/rest/v1/behaviors/%{id}.json'
+      define_writable_attributes :path, :behavior, :value
+      define_readonly_attributes :id, :path, :behavior, :value
+    end
+  end
+end

data/lib/brick_ftp/api/behavior_folder.rb

@@ -0,0 +1,8 @@
+module BrickFTP
+  module API
+    class BehaviorFolder < Base
+      define_api :index, '/api/rest/v1/behaviors/folders/%{path}'
+      define_readonly_attributes :id, :path, :behavior, :value
+    end
+  end
+end

data/lib/brick_ftp/api/bundle.rb

@@ -0,0 +1,12 @@
+module BrickFTP
+  module API
+    class Bundle < Base
+      define_api :index,  '/api/rest/v1/bundles.json'
+      define_api :show,   '/api/rest/v1/bundles/%{id}.json'
+      define_api :create, '/api/rest/v1/bundles.json'
+      define_api :delete, '/api/rest/v1/bundles/%{id}.json'
+      define_writable_attributes :paths
+      define_readonly_attributes :id, :code, :url, :user_id, :created_at
+    end
+  end
+end

data/lib/brick_ftp/api/bundle_content.rb

@@ -0,0 +1,20 @@
+module BrickFTP
+  module API
+    class BundleContent < Base
+      define_api :index, '/api/rest/v1/bundles/folders%{path}'
+      define_writable_attributes :code, :host
+      define_readonly_attributes :id, :path, :type, :size, :crc32, :md5
+
+      def self.all(params, path_params = {})
+        params.symbolize_keys!
+        undefined_attributes = params.keys - writable_attributes
+        raise UndefinedAttributesError, undefined_attributes unless undefined_attributes.empty?
+
+        path_params[:path] = '' unless path_params.key?(:path)
+
+        data = BrickFTP::HTTPClient.new.post(api_path_for(:index, path_params), params: params)
+        data.map { |x| new(x.symbolize_keys) }
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/bundle_download.rb

@@ -0,0 +1,18 @@
+module BrickFTP
+  module API
+    class BundleDownload < Base
+      define_api :index, '/api/rest/v1/bundles/files.json'
+      define_writable_attributes :code, :host, :paths
+      define_readonly_attributes :id, :path, :type, :size, :crc32, :md5, :download_uri
+
+      def self.all(params, path_params = {})
+        params.symbolize_keys!
+        undefined_attributes = params.keys - writable_attributes
+        raise UndefinedAttributesError, undefined_attributes unless undefined_attributes.empty?
+
+        data = BrickFTP::HTTPClient.new.post(api_path_for(:index, path_params), params: params)
+        data.map { |x| new(x.symbolize_keys) }
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/file.rb

@@ -0,0 +1,9 @@
+module BrickFTP
+  module API
+    class File < Base
+      define_api :show,   '/api/rest/v1/files/%{path}'
+      define_api :delete, '/api/rest/v1/files/%{path}'
+      define_readonly_attributes :id, :path, :type, :size, :mtime, :crc32, :md5, :download_uri, :provided_mtime, :permissions
+    end
+  end
+end

data/lib/brick_ftp/api/file_copy.rb

@@ -0,0 +1,8 @@
+module BrickFTP
+  module API
+    class FileCopy < Base
+      define_api :create, '/api/rest/v1/files/%{path}'
+      define_writable_attributes :'copy-destination'
+    end
+  end
+end

data/lib/brick_ftp/api/file_move.rb

@@ -0,0 +1,8 @@
+module BrickFTP
+  module API
+    class FileMove < Base
+      define_api :create, '/api/rest/v1/files/%{path}'
+      define_writable_attributes :'move-destination'
+    end
+  end
+end

data/lib/brick_ftp/api/file_upload.rb

@@ -0,0 +1,43 @@
+module BrickFTP
+  module API
+    class FileUpload < Base
+      define_api :create, '/api/rest/v1/files/%{path}'
+      define_writable_attributes :action, :ref, :part, :restart
+      define_readonly_attributes :id,
+                                 :ref,
+                                 :http_method,
+                                 :upload_uri,
+                                 :partsize,
+                                 :part_number,
+                                 :available_parts,
+                                 :headers,
+                                 :parameters,
+                                 :send,
+                                 :path,
+                                 :action,
+                                 :ask_about_overwrites,
+                                 :type,
+                                 :size,
+                                 :mtime,
+                                 :crc32,
+                                 :md5,
+                                 :expires,
+                                 :next_partsize,
+                                 :provided_mtime,
+                                 :permissions
+
+      def self.create(params, path_params = {})
+        api_client = BrickFTP::HTTPClient.new
+        step1 = api_client.post(api_path_for(:create, path_params), params: { action: 'put' })
+
+        upload_uri = URI.parse(step1['upload_uri'])
+        upload_client = BrickFTP::HTTPClient.new(upload_uri.host)
+        upload_client.put(step1['upload_uri'], params: params)
+
+        step3 = api_client.post(api_path_for(:create, path_params), params: { action: 'end', ref: step1['ref'] })
+
+        new(step1.merge(step3).symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/folder.rb

@@ -0,0 +1,13 @@
+module BrickFTP
+  module API
+    class Folder < Base
+      define_api :index,  '/api/rest/v1/folders/%{path}'
+      define_api :create, '/api/rest/v1/folders/%{path}'
+      define_readonly_attributes :id, :path, :type, :size, :mtime, :crc32, :md5, :provided_mtime, :permissions
+
+      def self.create(path_params = {})
+        super({}, path_params)
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/group.rb

@@ -0,0 +1,13 @@
+module BrickFTP
+  module API
+    class Group < Base
+      define_api :index,  '/api/rest/v1/groups.json'
+      define_api :show,   '/api/rest/v1/groups/%{id}.json'
+      define_api :create, '/api/rest/v1/groups.json'
+      define_api :update, '/api/rest/v1/groups/%{id}.json'
+      define_api :delete, '/api/rest/v1/groups/%{id}.json'
+      define_writable_attributes :name, :notes, :user_ids
+      define_readonly_attributes :id
+    end
+  end
+end

data/lib/brick_ftp/api/history.rb

@@ -0,0 +1,6 @@
+module BrickFTP
+  module APi
+    module History
+    end
+  end
+end

data/lib/brick_ftp/api/history/file.rb

@@ -0,0 +1,21 @@
+module BrickFTP
+  module API
+    module History
+      class File < BrickFTP::API::Base
+        define_api :index, '/api/rest/v1/history/files/%{path}'
+        define_readonly_attributes :id,
+                                   :when,
+                                   :user_id,
+                                   :username,
+                                   :action,
+                                   :failure_type,
+                                   :path,
+                                   :source,
+                                   :destination,
+                                   :targets,
+                                   :ip,
+                                   :interface
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/history/folder.rb

@@ -0,0 +1,21 @@
+module BrickFTP
+  module API
+    module History
+      class Folder < BrickFTP::API::Base
+        define_api :index, '/api/rest/v1/history/folders/%{path}'
+        define_readonly_attributes :id,
+                                   :when,
+                                   :user_id,
+                                   :username,
+                                   :action,
+                                   :failure_type,
+                                   :path,
+                                   :source,
+                                   :destination,
+                                   :targets,
+                                   :ip,
+                                   :interface
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/history/login.rb

@@ -0,0 +1,21 @@
+module BrickFTP
+  module API
+    module History
+      class Login < BrickFTP::API::Base
+        define_api :index, '/api/rest/v1/history/login.json'
+        define_readonly_attributes :id,
+                                   :when,
+                                   :user_id,
+                                   :username,
+                                   :action,
+                                   :failure_type,
+                                   :path,
+                                   :source,
+                                   :destination,
+                                   :targets,
+                                   :ip,
+                                   :interface
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/history/site.rb

@@ -0,0 +1,21 @@
+module BrickFTP
+  module API
+    module History
+      class Site < BrickFTP::API::Base
+        define_api :index, '/api/rest/v1/history.json'
+        define_readonly_attributes :id,
+                                   :when,
+                                   :user_id,
+                                   :username,
+                                   :action,
+                                   :failure_type,
+                                   :path,
+                                   :source,
+                                   :destination,
+                                   :targets,
+                                   :ip,
+                                   :interface
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/history/user.rb

@@ -0,0 +1,21 @@
+module BrickFTP
+  module API
+    module History
+      class User < BrickFTP::API::Base
+        define_api :index, '/api/rest/v1/history/users/%{user_id}.json'
+        define_readonly_attributes :id,
+                                   :when,
+                                   :user_id,
+                                   :username,
+                                   :action,
+                                   :failure_type,
+                                   :path,
+                                   :source,
+                                   :destination,
+                                   :targets,
+                                   :ip,
+                                   :interface
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/notification.rb

@@ -0,0 +1,11 @@
+module BrickFTP
+  module API
+    class Notification < Base
+      define_api :index,  '/api/rest/v1/notifications.json'
+      define_api :create, '/api/rest/v1/notifications.json'
+      define_api :delete, '/api/rest/v1/notifications/%{id}.json'
+      define_writable_attributes :path, :user_id, :username
+      define_readonly_attributes :id
+    end
+  end
+end

data/lib/brick_ftp/api/permission.rb

@@ -0,0 +1,11 @@
+module BrickFTP
+  module API
+    class Permission < Base
+      define_api :index,  '/api/rest/v1/permissions.json'
+      define_api :create, '/api/rest/v1/permissions.json'
+      define_api :delete, '/api/rest/v1/permissions/%{id}.json'
+      define_writable_attributes :path, :permission, :user_id, :username, :group_id
+      define_readonly_attributes :id, :recursive
+    end
+  end
+end

data/lib/brick_ftp/api/public_key.rb

@@ -0,0 +1,11 @@
+module BrickFTP
+  module API
+    class PublicKey < Base
+      define_api :index,  '/api/rest/v1/users/%{user_id}/public_keys.json'
+      define_api :create, '/api/rest/v1/users/%{user_id}/public_keys.json'
+      define_api :delete, '/api/rest/v1/public_keys/%{id}.json'
+      define_writable_attributes :title, :public_key
+      define_readonly_attributes :id, :fingerprint, :created_at
+    end
+  end
+end

data/lib/brick_ftp/api/user.rb

@@ -0,0 +1,35 @@
+module BrickFTP
+  module API
+    class User < Base
+      define_api :index,  '/api/rest/v1/users.json'
+      define_api :show,   '/api/rest/v1/users/%{id}.json'
+      define_api :create, '/api/rest/v1/users.json'
+      define_api :update, '/api/rest/v1/users/%{id}.json'
+      define_api :delete, '/api/rest/v1/users/%{id}.json'
+      define_writable_attributes :username,
+                                 :password,
+                                 :name,
+                                 :email,
+                                 :notes,
+                                 :group_ids,
+                                 :ftp_permission,
+                                 :web_permission,
+                                 :sftp_permission,
+                                 :dav_permission,
+                                 :restapi_permission,
+                                 :attachments_permission,
+                                 :self_managed,
+                                 :require_password_change,
+                                 :allowed_ips,
+                                 :user_root,
+                                 :grant_permission,
+                                 :ssl_required,
+                                 :authentication_method
+      define_readonly_attributes :id,
+                                 :last_login_at,
+                                 :time_zone,
+                                 :language,
+                                 :site_admin
+    end
+  end
+end

data/lib/brick_ftp/client.rb

@@ -0,0 +1,9 @@
+module BrickFTP
+  class Client
+    attr_reader :api_key
+
+    def initialize(api_key: nil)
+      @api_key = api_key
+    end
+  end
+end

data/lib/brick_ftp/configuration.rb

@@ -0,0 +1,23 @@
+require 'logger'
+
+module BrickFTP
+  class Configuration
+    attr_accessor :subdomain
+    attr_accessor :api_key
+    attr_accessor :session
+    attr_accessor :logger
+
+    def initialize
+      self.subdomain = ENV['BRICK_FTP_SUBDOMAIN']
+      self.api_key = ENV['BRICK_FTP_API_KEY']
+      self.session = nil
+
+      self.logger = Logger.new(STDOUT)
+      logger.level = Logger::WARN
+    end
+
+    def api_host
+      "#{subdomain}.brickftp.com"
+    end
+  end
+end

data/lib/brick_ftp/http_client.rb

@@ -0,0 +1,100 @@
+require 'net/https'
+require 'json'
+
+module BrickFTP
+  class HTTPClient
+    class Error < StandardError
+      def initialize(response)
+        begin
+          error = JSON.parse(response.body)
+        rescue
+          error = { 'http-code' => response.code, 'error' => "#{response.message}, #{response.body}" }
+        end
+
+        case
+        when error.key?('http-code')
+          super "#{error['http-code']}: #{error['error']}"
+        when error.key?('errors')
+          super error['errors'].join('. ')
+        else
+          super 'unknown error.'
+        end
+      end
+    end
+
+    USER_AGENT = 'BrickFTP Client/0.1 (https://github.com/koshigoe/brick_ftp)'.freeze
+
+    def initialize(host = nil)
+      @host = host || BrickFTP.config.api_host
+      @conn = Net::HTTP.new(@host, 443)
+      @conn.use_ssl = true
+    end
+
+    def get(path)
+      case res = request(:get, path)
+      when Net::HTTPSuccess
+        res.body.nil? || res.body.empty? ? {} : JSON.parse(res.body)
+      else
+        # TODO: redirect
+        raise Error, res
+      end
+    end
+
+    def post(path, params: {})
+      case res = request(:post, path, params: params)
+      when Net::HTTPSuccess, Net::HTTPCreated
+        res.body.nil? || res.body.empty? ? {} : JSON.parse(res.body)
+      else
+        # TODO: redirect
+        raise Error, res
+      end
+    end
+
+    def put(path, params: {})
+      case res = request(:put, path, params: params)
+      when Net::HTTPSuccess
+        res.body.nil? || res.body.empty? ? {} : JSON.parse(res.body)
+      else
+        # TODO: redirect
+        raise Error, res
+      end
+    end
+
+    def delete(path)
+      case res = request(:delete, path)
+      when Net::HTTPSuccess
+        true
+      else
+        # TODO: redirect
+        raise Error, res
+      end
+    end
+
+    private
+
+    def request(method, path, params: {}, headers: {})
+      req = Net::HTTP.const_get(method.to_s.capitalize).new(path, headers)
+      req['User-Agent'] = USER_AGENT
+
+      if @host == BrickFTP.config.api_host
+        req['Content-Type'] = 'application/json'
+        case
+        when BrickFTP.config.session
+          req['Cookie'] = BrickFTP::API::Authentication.cookie(BrickFTP.config.session).to_s
+        when BrickFTP.config.api_key
+          req.basic_auth(BrickFTP.config.api_key, 'x')
+        end
+      end
+
+      case
+      when params.is_a?(Hash)
+        req.body = params.to_json unless params.empty?
+      when params.is_a?(IO)
+        req.body_stream = params
+        req["Content-Length"] = params.size
+      end
+
+      @conn.request(req)
+    end
+  end
+end

data/lib/brick_ftp/version.rb

@@ -0,0 +1,3 @@
+module BrickFTP
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: brick_ftp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- koshigoe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: deep_hash_transform
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: BrickFTP's REST API client.
+email:
+- koshigoeb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brick_ftp.gemspec
+- lib/brick_ftp.rb
+- lib/brick_ftp/api.rb
+- lib/brick_ftp/api/authentication.rb
+- lib/brick_ftp/api/authentication/session.rb
+- lib/brick_ftp/api/base.rb
+- lib/brick_ftp/api/behavior.rb
+- lib/brick_ftp/api/behavior_folder.rb
+- lib/brick_ftp/api/bundle.rb
+- lib/brick_ftp/api/bundle_content.rb
+- lib/brick_ftp/api/bundle_download.rb
+- lib/brick_ftp/api/file.rb
+- lib/brick_ftp/api/file_copy.rb
+- lib/brick_ftp/api/file_move.rb
+- lib/brick_ftp/api/file_upload.rb
+- lib/brick_ftp/api/folder.rb
+- lib/brick_ftp/api/group.rb
+- lib/brick_ftp/api/history.rb
+- lib/brick_ftp/api/history/file.rb
+- lib/brick_ftp/api/history/folder.rb
+- lib/brick_ftp/api/history/login.rb
+- lib/brick_ftp/api/history/site.rb
+- lib/brick_ftp/api/history/user.rb
+- lib/brick_ftp/api/notification.rb
+- lib/brick_ftp/api/permission.rb
+- lib/brick_ftp/api/public_key.rb
+- lib/brick_ftp/api/user.rb
+- lib/brick_ftp/client.rb
+- lib/brick_ftp/configuration.rb
+- lib/brick_ftp/http_client.rb
+- lib/brick_ftp/version.rb
+homepage: https://github.com/koshigoe/brick_ftp
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: BrickFTP's REST API client.
+test_files: []