direct_admin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56f4b3c401671eee31fef798b7148c8b27bc5f50
+  data.tar.gz: f0da1e4026fd7b53e9bcc2847ed958289e0005fb
+SHA512:
+  metadata.gz: 7fbd723f9ee51975c0a73a5a8471897093b62a493d223fe84d1806a12a5e41e2a665c4e9dec646f06a0bd7dc24d666f438aa65e4d50ddd72f636f71398fd782d
+  data.tar.gz: c7cffe79128d54c819362fffac3658344fad17d0cc05062a5dcd08ee8cc619730b12129f2a139efbadd101dbad8d5cba709c3ddcf46d10ffd9aac03207920a20

data/README.md

@@ -0,0 +1,57 @@
+# DirectAdmin API Client
+
+An unofficial (and very incomplete) API client for the DirectAdmin webhosting
+control panel.
+
+## Installation
+
+```ruby
+gem "direct_admin"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install direct_admin
+
+## Usage
+
+First you will need to create an instance of the client:
+
+```ruby
+require "direct_admin"
+
+client = DirectAdmin::Client.new(url: "https://localhost:2222", username: "admin", password: "secret")
+```
+
+And then you can call any of the Command methods on the client:
+
+```ruby
+client.create_login_key("CLI Tool", "abcd1234")
+```
+
+## Limitations
+
+This library is purposely not feature complete. The DirectAdmin API is very large,
+and spread out over a large knowledgebase.
+
+I'm implementing what I need when it's needed, but will welcome contributions,
+provided they are accompanied with tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adam12/direct_admin.
+
+I love pull requests! If you fork this project and modify it, please ping me to see
+if your changes can be incorporated back into this project.
+
+That said, if your feature idea is nontrivial, you should probably open an issue to
+[discuss it](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/)
+before attempting a pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/direct_admin.rb

@@ -0,0 +1,5 @@
+require_relative "direct_admin/version"
+require_relative "direct_admin/client"
+
+module DirectAdmin
+end

data/lib/direct_admin/client.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require_relative "commands"
+require_relative "request"
+
+module DirectAdmin
+  class Client
+    include DirectAdmin::Commands
+
+    # URL of the DirectAdmin server
+    attr_accessor :url
+    alias server_url url
+
+    # Username to authenticate with
+    attr_accessor :username
+    alias server_username username
+
+    # Password to authenticate with
+    attr_accessor :password
+    alias server_password password
+
+    # Create a new instance of the Client
+    #
+    # == Required Arguments
+    #
+    # :url :: The url of the DirectAdmin server.
+    # :username :: A username to login as.
+    # :password :: The password which correspondes to the username.
+    def initialize(url:, username:, password:)
+      @url = url
+      @username = username
+      @password = password
+    end
+
+    def _request(method, endpoint, params) # :nodoc:
+      Request.new(self, method, endpoint, params)
+    end
+  end
+end

data/lib/direct_admin/commands.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+module DirectAdmin
+  module Commands
+    # Create a login key
+    #
+    #   client.create_login_key("CLI Tool", "abcd1234")
+    #
+    # == Required Arguments
+    #
+    # :name :: The name of the login key
+    # :value :: The value of the login key
+    def create_login_key(name, value, options = {})
+      never_expires = options.fetch(:never_expires, false)
+      expiration = options[:expiration]
+      allow_htm = options.fetch(:allow_htm, true)
+      allowed_commands = options.fetch(:allowed_commands, [])
+      allowed_ips = options.fetch(:allowed_ips, []).join("\r\n")
+      max_uses = options.fetch(:max_uses, 1)
+      clear_key = options.fetch(:clear_key, false)
+
+      params = {
+        "keyname" => name,
+        "key" => value,
+        "key2" => value,
+        "never_expires" => never_expires,
+        "max_uses" => max_uses,
+        "ips" => allowed_ips,
+        "passwd" => server_password,
+        "create" => "Create"
+      }
+
+      params["never_expires"] = "yes" if never_expires
+      params["clear_key"] = "yes" if clear_key
+      params["allow_htm"] = "yes" if allow_htm
+
+      if !never_expires && expiration
+        params["hour"] = expiration.hour
+        params["minute"] = expiration.minute
+        params["month"] = expiration.month
+        params["day"] = expiration.day
+        params["year"] = expiration.year
+      end
+
+      allowed_commands.each_with_index do |command, i|
+        params["select_allow#{i}"] = command
+      end
+
+      request(:post, "/CMD_API_LOGIN_KEYS", params)
+    end
+  end
+end

data/lib/direct_admin/request.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require "uri"
+require "cgi"
+require "http"
+
+module DirectAdmin
+  class Request
+    attr_reader :method, :endpont, :params, :url
+
+    def initialize(client, method, endpoint, params)
+      @method   = method
+      @endpoint = endpoint
+      @params   = params
+      @url      = URI.join(client.server_url, endpoint).to_s if client
+    end
+
+    def call
+      response = _make_request
+
+      if response.status == 404
+        raise DirectAdmin::Error, "Invalid URL: #{url}"
+      end
+
+      parsed_body = _parse_response(response.to_s)
+
+      unless response.code == 200
+        raise DirectAdmin::Error, parsed_body["reason"]
+      end
+
+      parsed_body
+    end
+
+    def _make_request
+      HTTP.basic_auth(user: client.server_username, pass: client.server_password)
+          .public_send(method, url, form: params)
+    end
+
+    def _parse_response(response)
+      CGI.parse(response).reduce({}) do |memo, (key, value)|
+        if value.is_a?(Array) && value.length == 1
+          memo[key] = value.first
+        else
+          memo[key] = value
+        end
+
+        memo
+      end
+    end
+  end
+end

data/lib/direct_admin/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module DirectAdmin
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: direct_admin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Daniels
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: |
+  An unofficial (and very incomplete) API client for the DirectAdmin webhosting
+  control panel.
+email: adam@mediadrive.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/direct_admin.rb
+- lib/direct_admin/client.rb
+- lib/direct_admin/commands.rb
+- lib/direct_admin/request.rb
+- lib/direct_admin/version.rb
+homepage: https://github.com/adam12/direct_admin
+licenses:
+- MIT
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Unofficial API for DirectAdmin
+test_files: []