pritunl_api_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57de66a4a4b74e8312eeacb682b1ce8060736965
+  data.tar.gz: 10234f4f8f1bb0ba189516c3c0dec406d9ec5df5
+SHA512:
+  metadata.gz: 5cf7ad74463442d38984f0c1bd1a4a3bf43f06edaa57a4b0631539a843cf44b40171206ef162f1cced53a9cd9a1fcec52a3095d1c427272e23ba02d21cc04525
+  data.tar.gz: 37b243f542fc76c9da1f5ed4e227ea5c78ef6091eb0220cbb47ea091493286c3492fcc42da6aab76ce6d4986b8992ce137860ca26d104eb618244e5542cd68f3

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Eric Terry
+
+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,518 @@
+# Pritunl API Client
+
+API client for Pritunl written in Ruby.
+
+[Pritunl](https://github.com/pritunl/pritunl) is a distributed enterprise
+vpn server built using the OpenVPN protocol. See the official Pritunl API
+documentation here: https://pritunl.com/api.html.  I am not affiliated with
+Pritunl at all, but couldn't find a Ruby client for their API.  So I scratched
+my own itch and created it myself.
+
+## Installation
+
+```bash
+gem install pritunl_api_client
+```
+
+## Usage
+
+```ruby
+require 'pritunl_api_client'
+
+@pritunl = PritunlApiClient::Client.new(
+  base_url:   'https://localhost:9700',
+  api_token:  'p7g444S3IZ5wmFvmzWmx14qACXdzQ25b',
+  api_secret: 'OpS9fjxkPI3DclkdKDDr6mqYVd0DJh4i',
+  verify_ssl: false
+)
+```
+
+## Ping
+
+### Server healthcheck.
+
+```ruby
+@pritunl.ping
+```
+
+## Status
+
+### Returns general information about the pritunl server.
+
+```ruby
+@pritunl.status
+
+{
+  "host_count" => 1,
+  "servers_online" => 1,
+  "hosts_online" => 1,
+  "server_count" => 2,
+  "server_version" => "1.11.813.26",
+  "public_ip" => "10.55.87.4",
+  "user_count" => 1,
+  "notification" => "",
+  "users_online" => 1,
+  "local_networks" => ["10.55.87.3/31", "10.2.214.0/31"],
+  "current_host" => "0f273a6c32ed45259c1ecb1ec3ac05ce",
+  "org_count" => 2
+}
+```
+
+## Log
+
+### Returns a list of server log entries sorted by time.
+
+```ruby
+@pritunl.log
+
+[
+  {
+    "timestamp" => 1450429682,
+    "message" => "Deleted organization 'org1'.",
+    "id" => "567386a32221390ea53d8047"
+  },
+  {
+    "timestamp" => 1450429682,
+    "message" => "Deleted user 'user1'.",
+    "id" => "567386a32221390ea53d8045"
+  },
+  {
+    "timestamp" => 1450429681,
+    "message" => "Enabled user 'user2'.",
+    "id" => "567386a22221390ea53d8042"
+  }
+]
+```
+
+## Events
+
+### Get a list of events (will poll up to 30 seconds)
+
+```ruby
+@pritunl.event( cursor: '55e9f1f1b0e730245677dc31' )
+
+[
+  {
+      "id" => "55e9f1f1b0e730245677dc31",
+      "type" => "users_updated",
+      "timestamp" => 1388495793,
+      "resource_id" => "55e9f1f8b0e730245677dc34"
+  },
+  {
+      "id" => "55e9f1f2b0e730245677dc32",
+      "type" => "server_organizations_updated",
+      "timestamp" => 1388495805,
+      "resource_id" => "55e9f1f8b0e730245677dc33"
+  }
+]
+```
+
+## Settings
+
+### Get system settings.
+
+```ruby
+@pritunl.settings.all
+
+{
+  "username" => "user6",
+  "sso_admin" => nil,
+  "theme" => "dark",
+  "sso" => nil,
+  "sso_match" => nil,
+  "server_cert" => "-----BEGIN CERTIFICATE----------END CERTIFICATE-----",
+  "public_address" => "10.5.8.46",
+  "routed_subnet6" => nil,
+  "email_username" => "user1",
+  "sso_saml_issuer_url" => nil,
+  "sso_saml_cert" => nil,
+  "sso_token" => nil,
+  "email_password" => true,
+  "sso_onelogin_key" => nil,
+  "email_server" => "smtp.example.com",
+  "auditing" => nil,
+  "sso_secret" => nil,
+  "server_key" => "-----BEGIN PRIVATE KEY----------END PRIVATE KEY-----",
+  "default" => nil,
+  "sso_host" => nil,
+  "public_address6" => "2605:1480:2:a210::1",
+  "secret" => "9D1ZJTscrr2mK4Xnxw76ltmpwnH7udeO",
+  "sso_okta_token" => nil,
+  "sso_saml_url" => nil,
+  "token" => "UQRM0R3bsXDpy3p6nqtjfrbjujSadaAx",
+  "sso_org" => nil,
+  "email_from" => "first.last@example.com"
+}
+```
+
+### Change the system settings.
+
+```ruby
+@pritunl.settings.update( theme: 'dark' )
+
+@pritunl.settings.update(
+  email_username: 'user1',
+  email_password: '12345',
+  email_server:   'smtp.example.com',
+  email_from:     'first.last@example.com'
+)
+```
+
+## Users
+
+### Returns a list of users in an organization sorted by name.
+
+```ruby
+@pritunl.user.all( organization_id: org['id'] )
+
+[
+  {
+    "auth_type" => "local",
+    "status" => false,
+    "dns_servers" => nil,
+    "otp_secret" => "OPT4HTURJTW6JLQN",
+    "dns_mapping" => nil,
+    "dns_suffix" => nil,
+    "servers" => [
+      {
+        "status" => false,
+        "platform" => nil,
+        "server_id" => "567369be2231390ea53d76d4",
+        "local_address" => "10.139.82.6",
+        "remote_address" => "10.139.82.7",
+        "virt_address6" => "fd00:c0a8:e800:0:10.139.82.6",
+        "virt_address" => "10.139.82.6",
+        "name" => "server1",
+        "real_address" => "8.8.8.8:41536",
+        "connected_since" => 1388498640,
+        "id" => "55e9f995b0e73033d45b44da",
+        "device_name" => nil
+      }
+    ],
+    "disabled" => false,
+    "network_links" => [],
+    "sso" => nil,
+    "bypass_secondary" => false,
+    "id" => "55e9f98cb0e73033d45b44d7",
+    "audit" => false,
+    "name" => "user0",
+    "organization_name" => "org1",
+    "gravatar" => true,
+    "otp_auth" => false,
+    "organization" => "55e9f7c7b0e73033d45b44d4",
+    "type" => "client",
+    "email" => "user0@example.com"
+  }
+]
+```
+
+### Returns a user from an organization.
+
+```ruby
+@pritunl.user.find( user['id'], organization_id: org['id'] )
+
+{
+  "auth_type" => "local",
+  "dns_servers" => nil,
+  "otp_secret" => "OPT4HTURJTW6JLQN",
+  "dns_suffix" => nil,
+  "disabled" => true,
+  "bypass_secondary" => false,
+  "id" => "55e9f98cb0e73033d45b44d7",
+  "name" => "user0",
+  "organization_name" => "org1",
+  "organization" => "55e9f7c7b0e73033d45b44d4",
+  "type" => "client",
+  "email" => "user0@example.com"
+}
+```
+
+### Create a new user in an organization. An array of users can be sent for bulk adding users.
+
+```ruby
+@pritunl.user.create(
+  organization_id: org['id'],
+  name: 'new_user',
+  email: 'new_user@example.com',
+  disabled: true
+)
+```
+
+### Rename or disabled an existing user in an organization. Disabling will also disconnect the user.
+
+```ruby
+@pritunl.user.update( user['id'],
+  organization_id: org['id'],
+  name: 'new_name',
+  email: 'new_email@example.com',
+  disabled: false
+)
+```
+
+### Delete an existing user in an organization, this will disconnect the user.
+
+```ruby
+@pritunl.user.delete( user['id'], organization_id: org['id'] )
+```
+
+### Generate a new two-step authentication secret for an existing user.
+
+```ruby
+@pritunl.user.otp_secret( user['id'], organization_id: org['id'] )
+```
+
+## Organizations
+
+### Returns a list of organizations on the server sorted by name.
+
+```ruby
+@pritunl.organization.all
+
+[
+  {
+    "user_count" => 512,
+    "id" => "55e99499b0e7300fef77e2b1",
+    "name" => "org1"
+  },
+  {
+    "user_count" => 1024,
+    "id" => "55e9f1d4b0e730245677dc2d",
+    "name" => "org2"
+  }
+]
+```
+
+### Returns an organization.
+
+```ruby
+@pritunl.organization.find( org['id'] )
+
+{
+  "user_count" => 512,
+  "id" => "55e99499b0e7300fef77e2b1",
+  "name" => "org1"
+}
+```
+
+### Create a new organization.
+
+```ruby
+@pritunl.organization.create( name: 'new_org' )
+```
+
+### Rename an existing organization.
+
+```ruby
+@pritunl.organization.update( org['id'], name: 'new_name' )
+```
+
+### Delete an existing organization.
+
+```ruby
+@pritunl.organization.delete( org['id'] )
+```
+
+## Keys
+
+### Download a users key tar archive.
+
+```ruby
+@pritunl.key.download_tar( organization_id: org['id'], user_id: user['id'], path: 'output.tar' )
+```
+
+### Download a users onc key zip archive.
+
+```ruby
+@pritunl.key.download_zip( organization_id: org['id'], user_id: user['id'], path: 'output.zip' )
+```
+
+### Generate a temporary url to download a users key archive.
+
+```ruby
+@pritunl.key.temporary_url( organization_id: org['id'], user_id: user['id'] )
+
+{
+  "view_url" => "/k/MjyaVvGk",
+  "key_url" => "/key/4f5bd04d85414e20b0a451d642dab06d.tar",
+  "uri_url" => "/ku/MjyaVvGk",
+  "key_zip_url" => "/key/4f5bd04d85414e20b0a451d642dab06d.zip",
+  "key_onc_url" => "/key_onc/4f5bd04d85414e20b0a451d642dab06d.zip",
+  "id" => "4f5bd04d85414e20b0a451d642dab06d"
+}
+```
+
+## Servers
+
+### Returns a list of servers.
+
+```ruby
+@pritunl.server.all
+```
+
+### Returns a server.
+
+```ruby
+@pritunl.server.find( server['id'] )
+
+{
+  "status" => "pending",
+  "lzo_compression" => false,
+  "dns_servers" => ["8.8.4.4"],
+  "protocol" => "udp",
+  "ping_interval" => 10,
+  "dns_mapping" => false,
+  "network_mode" => "tunnel",
+  "debug" => false,
+  "network_end" => nil,
+  "bind_address" => nil,
+  "link_ping_interval" => 1,
+  "hash" => "sha1",
+  "ipv6_firewall" => true,
+  "inter_client" => true,
+  "id" => "5678d5286231390ea53eda96",
+  "network_start" => nil,
+  "network" => "10.11.6.0/24",
+  "local_networks" => [],
+  "uptime" => nil,
+  "user_count" => 0,
+  "name" => "server1",
+  "dh_param_bits" => 2048,
+  "max_clients" => 2048,
+  "users_online" => 0,
+  "replica_count" => 1,
+  "link_ping_timeout" => 5,
+  "port" => 12533,
+  "devices_online" => 0,
+  "ping_timeout" => 60,
+  "mode" => "all_traffic",
+  "ipv6" => false,
+  "otp_auth" => false,
+  "jumbo_frames" => false,
+  "multi_device" => false,
+  "search_domain" => "example.com",
+  "cipher" => "aes256"
+}
+```
+
+### Create a new server.
+
+```ruby
+@pritunl.server.create(
+  name: 'server1',
+  network: '10.11.6.0/24',
+  bind_address: nil,
+  port: 12533,
+  protocol: 'udp',
+  dh_param_bits: 2048,
+  mode: 'all_traffic',
+  network_mode: 'tunnel',
+  network_start: nil,
+  network_end: nil,
+  multi_device: false,
+  local_networks: [],
+  dns_servers: ['8.8.4.4'],
+  search_domain: 'pritunl.com',
+  otp_auth: false,
+  cipher: 'aes256',
+  jumbo_frames: false,
+  lzo_compression: false,
+  inter_client: true,
+  ping_interval: 10,
+  ping_timeout: 60,
+  max_clients: 2048,
+  replica_count: 1,
+  debug: false
+)
+```
+
+### Update an existing server.
+
+```ruby
+@pritunl.server.update( server['id'], name: 'server1-rename', dns_servers: ['8.8.8.8', '8.8.4.4'] )
+```
+
+### Delete an existing server.
+
+```ruby
+@pritunl.server.delete( server['id'] )
+```
+
+### Start, stop or restart an existing server.
+
+```ruby
+@pritunl.server.start( server['id'] )
+@pritunl.server.stop( server['id'] )
+@pritunl.server.restart( server['id'] )
+```
+
+### Returns a list of organizations attached to a server.
+
+```ruby
+@pritunl.server.organizations( server['id'] )
+
+[
+  {
+    "id" => "5678d0f48831390da53ef8ae",
+    "name" => "org1",
+    "server" => "5678d5286231390ea53eda96"
+  },
+  {
+    "id" => "5678d0f48831392ba71ad3cb",
+    "name" => "org2",
+    "server" => "5678d5286231390ea53eda96"
+  }
+]
+```
+
+### Attach an organization to an existing server.
+
+```ruby
+@pritunl.server.attach_organization( server['id'], organization_id: org['id'] )
+
+{
+  "id" => "5678d0f48831390da53ef8ae",
+  "name" => "org1",
+  "server" => "5678d5286231390ea53eda96"
+}
+```
+
+### Remove an organization from an existing server.
+
+```ruby
+@pritunl.server.remove_organization( server['id'], organization_id: org['id'] )
+```
+
+### Get the output of a server.
+
+```ruby
+@pritunl.server.output( server['id'] )
+
+{
+  "id" => "5678d5286231390ea53eda96",
+  "output" => [
+    "[patient-forest-4024] Mon Dec 21 23:45:15 2015 OpenVPN 2.3.2 x86_64-pc-linux-gnu [SSL (OpenSSL)] [LZO] [EPOLL] [PKCS11] [eurephia] [MH] [IPv6] built on Dec  1 2014",
+    "[patient-forest-4024] Mon Dec 21 23:45:15 2015 Control Channel Authentication: tls-auth using INLINE static key file",
+    "[patient-forest-4024] Mon Dec 21 23:45:15 2015 TUN/TAP device tun11 opened",
+    "[patient-forest-4024] Mon Dec 21 23:45:15 2015 do_ifconfig, tt->ipv6=0, tt->did_ifconfig_ipv6_setup=0",
+    "[patient-forest-4024] Mon Dec 21 23:45:15 2015 /sbin/ip link set dev tun11 up mtu 1500",
+    "[patient-forest-4024] Mon Dec 21 23:45:15 2015 /sbin/ip addr add dev tun11 10.11.6.1/24 broadcast 10.11.6.255",
+    "[patient-forest-4024] Mon Dec 21 23:45:15 2015 UDPv4 link local (bound): [undef]",
+    "[patient-forest-4024] Mon Dec 21 23:45:15 2015 UDPv4 link remote: [undef]",
+    "[patient-forest-4024] Mon Dec 21 23:45:15 2015 Initialization Sequence Completed"
+  ]
+}
+```
+
+### Clear the output of a server.
+
+```ruby
+@pritunl.server.clear_output( server['id'] )
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/eterry1388/pritunl_api_client.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 'pritunl_api_client'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pritunl_api_client.rb

@@ -0,0 +1,103 @@
+require_relative 'pritunl_api_client/api'
+require_relative 'pritunl_api_client/settings'
+require_relative 'pritunl_api_client/organization'
+require_relative 'pritunl_api_client/user'
+require_relative 'pritunl_api_client/key'
+require_relative 'pritunl_api_client/server'
+
+# API client for Pritunl. Pritunl is a distributed enterprise vpn server built
+# using the OpenVPN protocol. See the official Pritunl API documentation here:
+# https://pritunl.com/api.html. I am not affiliated with Pritunl at all, but
+# couldn't find a Ruby client for their API. So I scratched my own itch and
+# created it myself.
+#
+# @author {mailto:eterry1388@aol.com Eric Terry}
+# @see https://github.com/eterry1388/pritunl_api_client
+module PritunlApiClient
+
+  # Main interface to the Pritunl api
+  class Client
+
+    # @param base_url [String] Full URL to a running Pritunl server (include the "https://")
+    # @param api_token [String
+    # @param api_secret [String]
+    # @param verify_ssl [Boolean] Whether or not to verify SSL certificate
+    def initialize( base_url:, api_token:, api_secret:, verify_ssl: true )
+      @base_url   = base_url
+      @api_token  = api_token
+      @api_secret = api_secret
+      @verify_ssl = verify_ssl
+      @api = Api.new( base_url: base_url, api_token: api_token, api_secret: api_secret, verify_ssl: verify_ssl )
+    end
+
+    # Get a list of events (will poll up to 30 seconds)
+    #
+    # @param cursor [String, NilClass] Optional id of last event. If left out, only events
+    #   that occurred after request is sent will be returned.
+    # @return [Array]
+    def event( cursor: nil )
+      @api.get( "/event/#{cursor}" )
+    end
+
+    # Server healthcheck
+    #
+    # @return [Boolean]
+    def ping
+      begin
+        @api.get( '/ping' ) == ''
+      rescue
+        false
+      end
+    end
+
+    # Returns general information about the pritunl server
+    #
+    # @return [Hash]
+    def status
+      @api.get( '/status' )
+    end
+
+    # Returns a list of server log entries
+    #
+    # @return [Array]
+    def log
+      @api.get( '/log' )
+    end
+
+    # Setting apis
+    #
+    # @return [PritunlApiClient::Settings]
+    def settings
+      @settings ||= Settings.new( @api )
+    end
+
+    # Organization apis
+    #
+    # @return [PritunlApiClient::Organization]
+    def organization
+      @organization ||= Organization.new( @api )
+    end
+
+    # User apis
+    #
+    # @return [PritunlApiClient::User]
+    def user
+      @user ||= User.new( @api )
+    end
+
+    # Key apis
+    #
+    # @return [PritunlApiClient::Key]
+    def key
+      @key ||= Key.new( @api )
+    end
+
+    # Server apis
+    #
+    # @return [PritunlApiClient::Server]
+    def server
+      @server ||= Server.new( @api )
+    end
+
+  end
+end

data/lib/pritunl_api_client/api.rb

@@ -0,0 +1,121 @@
+require 'rest-client'
+require 'securerandom'
+require 'base64'
+require 'json'
+
+module PritunlApiClient
+
+  # Low-level communication to api server
+  class Api
+
+    # @param base_url [String] Full URL to a running Pritunl server (include the "https://")
+    # @param api_token [String
+    # @param api_secret [String]
+    # @param verify_ssl [Boolean] Whether or not to verify SSL certificate]
+    def initialize( base_url:, api_token:, api_secret:, verify_ssl: true )
+      @api_token = api_token
+      @api_secret = api_secret
+      @client = RestClient::Resource.new( base_url, verify_ssl: verify_ssl )
+    end
+
+    # Send post request to api server
+    #
+    # @param path [String] URL path of api
+    # @param params [Hash, NilClass] Api parameters
+    # @return [Hash, Array, String] Response from api server
+    def post( path, params = nil )
+      headers = common_headers.merge( generate_auth_headers( path: path, params: params, method: 'POST' ) )
+      params = JSON.generate( params, space: ' ' ) if params
+      parse_data @client[path].post( params, headers )
+    end
+
+    # Send get request to api server
+    #
+    # @param path [String] URL path of api
+    # @param params [Hash, NilClass] Api parameters
+    # @return [Hash, Array, String] Response from api server
+    def get( path, params = nil )
+      parameters = { params: params }
+      parameters.merge!( common_headers )
+      parameters.merge!( generate_auth_headers( path: path, params: params, method: 'GET' ) )
+      parse_data @client[path].get( parameters )
+    end
+
+    # Send put request to api server
+    #
+    # @param path [String] URL path of api
+    # @param params [Hash, NilClass] Api parameters
+    # @return [Hash, Array, String] Response from api server
+    def put( path, params = nil )
+      headers = common_headers.merge( generate_auth_headers( path: path, params: params, method: 'PUT' ) )
+      params = JSON.generate( params, space: ' ' ) if params
+      parse_data @client[path].put( params, headers )
+    end
+
+    # Send delete request to api server
+    #
+    # @param path [String] URL path of api
+    # @param params [Hash, NilClass] Api parameters
+    # @return [Hash, Array, String] Response from api server
+    def delete( path, params = nil )
+      parameters = { params: params }
+      parameters.merge!( common_headers )
+      parameters.merge!( generate_auth_headers( path: path, params: params, method: 'DELETE' ) )
+      parse_data @client[path].delete( parameters )
+    end
+
+    # Send head request to api server
+    #
+    # @param path [String] URL path of api
+    # @param params [Hash, NilClass] Api parameters
+    # @return [Hash, Array, String] Response from api server
+    def head( path, params = nil )
+      headers = common_headers.merge( generate_auth_headers( path: path, params: params, method: 'HEAD' ) )
+      params = JSON.generate( params, space: ' ' ) if params
+      parse_data @client[path].head( params, headers )
+    end
+
+    private
+
+    # Common headers to add to every request
+    #
+    # @return [Hash]
+    def common_headers
+      { content_type: :json, accept: :json }
+    end
+
+    # Authentication algorithm that is included in every request
+    #
+    # @param path [String] URL path of api
+    # @param params [Hash, NilClass] Api parameters
+    # @param method [String] Uppercase method for the request
+    # @return [Hash]
+    def generate_auth_headers( path:, params: nil, method: )
+      auth_timestamp = Time.now.to_i
+      auth_nonce = SecureRandom.hex( 16 )
+      auth_string = [@api_token, auth_timestamp, auth_nonce, method, path]
+      auth_string << JSON.generate( params, space: ' ' ) if params
+      auth_string = auth_string.join( '&' )
+      digest = OpenSSL::Digest.new( 'sha256' )
+      hmac = OpenSSL::HMAC.digest( digest, @api_secret, auth_string )
+      auth_signature = Base64.encode64( hmac ).chomp
+      {
+        auth_token:     @api_token,
+        auth_timestamp: auth_timestamp,
+        auth_nonce:     auth_nonce,
+        auth_signature: auth_signature
+      }
+    end
+
+    # Parse responses back from api server
+    #
+    # @param data [String]
+    # @return [Hash, Array, String]
+    def parse_data( data )
+      JSON.parse( data )
+    rescue JSON::ParserError => e
+      data
+    end
+
+  end
+end

data/lib/pritunl_api_client/key.rb

@@ -0,0 +1,45 @@
+module PritunlApiClient
+
+  # Interact with /key api's
+  class Key
+
+    # @param api [PritunlApiClient::Api]
+    def initialize( api )
+      @api = api
+    end
+
+    # Download a users key tar archive
+    #
+    # @param organization_id [String]
+    # @param user_id [String]
+    # @param path [String] Local path to save downloaded file
+    # @return [String] Local path to downloaded file
+    def download_tar( organization_id:, user_id:, path: )
+      data = @api.get( "/key/#{organization_id}/#{user_id}.tar" )
+      File.write( path, data )
+      path
+    end
+
+    # Download a users onc key zip archive
+    #
+    # @param organization_id [String]
+    # @param user_id [String]
+    # @param path [String] Local path to save downloaded file
+    # @return [String] Local path to downloaded file
+    def download_zip( organization_id:, user_id:, path: )
+      data = @api.get( "/key_onc/#{organization_id}/#{user_id}.zip" )
+      File.write( path, data )
+      path
+    end
+
+    # Generate a temporary url to download a users key archive 
+    #
+    # @param organization_id [String]
+    # @param user_id [String]
+    # @return [Hash]
+    def temporary_url( organization_id:, user_id: )
+      @api.get( "/key/#{organization_id}/#{user_id}" )
+    end
+
+  end
+end

data/lib/pritunl_api_client/organization.rb

@@ -0,0 +1,55 @@
+module PritunlApiClient
+  
+  # Interact with /organization api's
+  class Organization
+
+    # @param api [PritunlApiClient::Api]
+    def initialize( api )
+      @api = api
+    end
+
+    # Returns a list of organizations on the server
+    #
+    # @return [Array]
+    def all
+      @api.get( '/organization' )
+    end
+
+    # Returns an organization
+    #
+    # @param id [String] Organization ID
+    # @return [Hash]
+    def find( id )
+      @api.get( "/organization/#{id}" )
+    end
+
+    # Create a new organization
+    #
+    # @param params [Hash]
+    # @raise [ArgumentError] if params is not a Hash
+    # @return [Hash]
+    def create( params )
+      fail ArgumentError, 'params must be a Hash' unless params.is_a? Hash
+      @api.post( '/organization', params )
+    end
+
+    # Modify an existing organization
+    #
+    # @param id [String] Organization ID
+    # @param params [Hash]
+    # @raise [ArgumentError] if params is not a Hash
+    # @return [Hash]
+    def update( id, params )
+      fail ArgumentError, 'params must be a Hash' unless params.is_a? Hash
+      @api.put( "/organization/#{id}", params )
+    end
+
+    # Delete an existing organization
+    #
+    # @param id [String] Organization ID
+    def delete( id )
+      @api.delete( "/organization/#{id}" )
+    end
+
+  end
+end

data/lib/pritunl_api_client/server.rb

@@ -0,0 +1,117 @@
+module PritunlApiClient
+
+  # Interact with /server api's
+  class Server
+
+    # @param api [PritunlApiClient::Api]
+    def initialize( api )
+      @api = api
+    end
+
+    # Returns a list of servers
+    #
+    # @return [Array]
+    def all
+      @api.get( '/server' )
+    end
+
+    # Returns a server
+    #
+    # @param id [String] Server ID
+    # @return [Hash]
+    def find( id )
+      @api.get( "/server/#{id}" )
+    end
+
+    # Create a new server
+    #
+    # @param params [Hash]
+    # @raise [ArgumentError] if params is not a Hash
+    # @return [Hash]
+    def create( params )
+      fail ArgumentError, 'params must be a Hash' unless params.is_a? Hash
+      @api.post( '/server', params )
+    end
+
+    # Update an existing server
+    #
+    # @param id [String] Server ID
+    # @param params [Hash]
+    # @raise [ArgumentError] if params is not a Hash
+    # @return [Hash]
+    def update( id, params )
+      fail ArgumentError, 'params must be a Hash' unless params.is_a? Hash
+      @api.put( "/server/#{id}", params )
+    end
+
+    # Delete an existing server
+    #
+    # @param id [String] Server ID
+    def delete( id )
+      @api.delete( "/server/#{id}" )
+    end
+
+    # Start an existing server
+    #
+    # @param id [String] Server ID
+    # @return [Hash]
+    def start( id )
+      @api.put( "/server/#{id}/start" )
+    end
+
+    # Stop an existing server
+    #
+    # @param id [String] Server ID
+    # @return [Hash]
+    def stop( id )
+      @api.put( "/server/#{id}/stop" )
+    end
+
+    # Restart an existing server
+    #
+    # @param id [String] Server ID
+    # @return [Hash]
+    def restart( id )
+      @api.put( "/server/#{id}/restart" )
+    end
+
+    # Returns a list of organizations attached to a server
+    #
+    # @param id [String] Server ID
+    # @return [Array]
+    def organizations( id )
+      @api.get( "/server/#{id}/organization" )
+    end
+
+    # Attach an organization to an existing server
+    #
+    # @param id [String] Server ID
+    # @return [Hash]
+    def attach_organization( id, organization_id: )
+      @api.put( "/server/#{id}/organization/#{organization_id}" )
+    end
+
+    # Remove an organization from an existing server
+    #
+    # @param id [String] Server ID
+    def remove_organization( id, organization_id: )
+      @api.delete( "/server/#{id}/organization/#{organization_id}" )
+    end
+
+    # Get the output of a server
+    #
+    # @param id [String] Server ID
+    # @return [Hash]
+    def output( id )
+      @api.get( "/server/#{id}/output" )
+    end
+
+    # Clear the output of a server
+    #
+    # @param id [String] Server ID
+    def clear_output( id )
+      @api.delete( "/server/#{id}/output" )
+    end
+
+  end
+end

data/lib/pritunl_api_client/settings.rb

@@ -0,0 +1,29 @@
+module PritunlApiClient
+
+  # Interact with /settings api's
+  class Settings
+
+    # @param api [PritunlApiClient::Api]
+    def initialize( api )
+      @api = api
+    end
+
+    # Get system settings
+    #
+    # @return [Array]
+    def all
+      @api.get( '/settings' )
+    end
+
+    # Change the system settings
+    #
+    # @param params [Hash]
+    # @raise [ArgumentError] if params is not a Hash
+    # @return [Hash]
+    def update( params )
+      fail ArgumentError, 'params must be a Hash' unless params.is_a? Hash
+      @api.put( '/settings', params )
+    end
+
+  end
+end

data/lib/pritunl_api_client/user.rb

@@ -0,0 +1,73 @@
+module PritunlApiClient
+
+  # Interact with /user api's
+  class User
+
+    # @param api [PritunlApiClient::Api]
+    def initialize( api )
+      @api = api
+    end
+
+    # Returns a list of users in an organization
+    #
+    # @param organization_id [String]
+    # @return [Array]
+    def all( organization_id: )
+      @api.get( "/user/#{organization_id}" )
+    end
+
+    # Returns a user from an organization
+    #
+    # @param id [String] User ID
+    # @param organization_id [String]
+    # @return [Hash]
+    def find( id, organization_id: )
+      @api.get( "/user/#{organization_id}/#{id}" )
+    end
+
+    # Create a new user in an organization. An array of users can be sent for bulk adding users
+    #
+    # @param params [Hash, Array]
+    # @raise [ArgumentError] if params is not a Hash or an Array
+    # @raise [ArgumentError] if organization_id is not passed into the parameter list
+    # @return [Hash, Array]
+    def create( params )
+      fail ArgumentError, 'params must be a Hash or an Array' unless ( params.is_a?( Hash ) || params.is_a?( Array ) )
+      fail ArgumentError, '"organization_id" is a required parameter' unless params.keys.include? :organization_id
+      organization_id = params.delete( :organization_id )
+      @api.post( "/user/#{organization_id}", params )
+    end
+
+    # Update an existing user in an organization
+    #
+    # @param id [String] User ID
+    # @param params [Hash]
+    # @raise [ArgumentError] if params is not a Hash
+    # @raise [ArgumentError] if organization_id is not passed into the parameter list
+    # @return [Hash]
+    def update( id, params )
+      fail ArgumentError, 'params must be a Hash' unless params.is_a? Hash
+      fail ArgumentError, '"organization_id" is a required parameter' unless params.keys.include? :organization_id
+      organization_id = params.delete( :organization_id )
+      @api.put( "/user/#{organization_id}/#{id}", params )
+    end
+
+    # Delete an existing user in an organization, this will disconnect the user
+    #
+    # @param id [String] User ID
+    # @param organization_id [String]
+    def delete( id, organization_id: )
+      @api.delete( "/user/#{organization_id}/#{id}" )
+    end
+
+    # Generate a new two-step authentication secret for an existing user
+    #
+    # @param id [String] User ID
+    # @param organization_id [String]
+    # @return [Hash]
+    def otp_secret( id, organization_id: )
+      @api.put( "/user/#{organization_id}/#{id}/otp_secret" )
+    end
+
+  end
+end

data/lib/pritunl_api_client/version.rb

@@ -0,0 +1,3 @@
+module PritunlApiClient
+  VERSION = '1.0.0'
+end

data/pritunl_api_client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path( '../lib', __FILE__ )
+$LOAD_PATH.unshift( lib ) unless $LOAD_PATH.include?( lib )
+require 'pritunl_api_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pritunl_api_client'
+  spec.version       = PritunlApiClient::VERSION
+  spec.authors       = ['Eric Terry']
+  spec.email         = ['eterry1388@aol.com']
+
+  spec.summary       = 'Pritunl Ruby API Client'
+  spec.description   = 'API client for Pritunl written in Ruby'
+  spec.homepage      = 'http://eterry1388.github.io/pritunl_api_client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split( "\x0" ).reject { |f| f.match( %r{^(test|spec|features)/} ) }
+  spec.executables   = spec.files.grep( %r{^bin/} ) { |f| File.basename( f ) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_dependency 'rest-client'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: pritunl_api_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eric Terry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: API client for Pritunl written in Ruby
+email:
+- eterry1388@aol.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pritunl_api_client.rb
+- lib/pritunl_api_client/api.rb
+- lib/pritunl_api_client/key.rb
+- lib/pritunl_api_client/organization.rb
+- lib/pritunl_api_client/server.rb
+- lib/pritunl_api_client/settings.rb
+- lib/pritunl_api_client/user.rb
+- lib/pritunl_api_client/version.rb
+- pritunl_api_client.gemspec
+homepage: http://eterry1388.github.io/pritunl_api_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Pritunl Ruby API Client
+test_files: []