pritunl_api_client 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3534d42cc32ee0ed36d274fe44bbcfd6f52dc3b1
-  data.tar.gz: ba4d158c8eb83dadb67efd9d1528ab036259044b
+  metadata.gz: 8893ac808d0c01beb6358428c5b63d8527463d55
+  data.tar.gz: 626352f2e452a8d8eb162da04258d6866204acc2
 SHA512:
-  metadata.gz: 83ccc8f360c7934d73a30e834aa485bd2d4608b84b42a436dbd0731a08f41573e280f3c0665aba1ae3a4e18f0fff0d2d3cd9e6ba6f513107d2ec280e56ee199f
-  data.tar.gz: 124eeac5e68aa17483f1f84df78adadfde48eb45ecaf73c3821a958f615b29fa31148aa70c332e9250dbb407bc322a597246ce5fb9aa2e0fe3da326e4b0c654f
+  metadata.gz: 3d2cd77747daec9516ef5994738461a89ce87988d66616115f3b3f40a3fb626c855e569dfae3e158d356b755a667a3a7fc3a8682d91d5c5393736382d5bba4d3
+  data.tar.gz: 989fc53e24ddd513854465ca42cbe318e87e5f62dd4131126e8e4f3df5b9c7d765d20232c10a05f83fb7e9b6cdac94e4119cfab19095f11c233e919035f2dbd5

data/README.md

@@ -1,12 +1,13 @@
 # Pritunl API Client
 
+[![Gem Version](https://badge.fury.io/rb/pritunl_api_client.svg)](https://badge.fury.io/rb/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.
+Pritunl.
 
 ## Installation
 
@@ -511,7 +512,61 @@ require 'pritunl_api_client'
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/eterry1388/pritunl_api_client.
+Bug reports and pull requests are welcome on GitHub at https://github.com/eterry1388/pritunl_api_client.  Please make sure
+all tests pass before making a pull request.  The tests are system tests (not unit tests), so please have a live Pritunl
+server up and running when executing the tests.
+
+### How to run system tests
+
+```bash
+BASE_URL='https://your-ip-address:9700' API_TOKEN='your-api-token' API_SECRET='your-api-secret' rspec
+```
+
+The output should look something like this:
+
+```
+PritunlApiClient
+  Ping server
+  Get server status
+  Get logs
+  Get events
+  PritunlApiClient::Organization
+    Create organization
+    Find organization
+    Update organization
+    Get all organizations
+    Delete organization
+  PritunlApiClient::User
+    Create user
+    Find user
+    Update user
+    Get all users
+    Generate two-step auth for user
+    Delete user
+  PritunlApiClient::Key
+    Get tar key
+    Get zip key
+    Get key temporary url
+  PritunlApiClient::Server
+    Create server
+    Find server
+    Get all servers
+    Update server
+    Attach organization
+    Get all organizations on server
+    Remove organization
+    Start server
+    Restart server
+    Stop server
+    Get server output
+    Clear server output
+  PritunlApiClient::Settings
+    Get all settings
+    Update settings
+
+Finished in 1 minute 14.14 seconds (files took 0.12978 seconds to load)
+32 examples, 0 failures
+```
 
 ## License
 

data/lib/pritunl_api_client.rb

@@ -7,12 +7,11 @@ 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.
+# https://pritunl.com/api.html. I am not affiliated with Pritunl.
 #
 # @author {mailto:eterry1388@aol.com Eric Terry}
 # @see https://github.com/eterry1388/pritunl_api_client
+# @note Tested with Pritunl server version 1.11.813.26
 module PritunlApiClient
 
   # Main interface to the Pritunl api

data/lib/pritunl_api_client/key.rb

@@ -16,19 +16,31 @@ module PritunlApiClient
     # @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 )
+      File.write( path, data.force_encoding( 'utf-8' ) )
       path
     end
 
-    # Download a users onc key zip archive
+    # Download a users 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/#{organization_id}/#{user_id}.zip" )
+      File.write( path, data.force_encoding( 'utf-8' ) )
+      path
+    end
+
+    # Download a users onc key (Chromebook profile) as a 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_chromebook_profile( organization_id:, user_id:, path: )
       data = @api.get( "/key_onc/#{organization_id}/#{user_id}.zip" )
-      File.write( path, data )
+      File.write( path, data.force_encoding( 'utf-8' ) )
       path
     end
 

data/lib/pritunl_api_client/version.rb

@@ -1,3 +1,3 @@
 module PritunlApiClient
-  VERSION = '1.0.1'
+  VERSION = '1.2.0'
 end

data/pritunl_api_client.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['eterry1388@aol.com']
 
   spec.summary       = 'Pritunl Ruby API Client'
-  spec.description   = "API client for Pritunl written in Ruby. 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."
+  spec.description   = "API client for Pritunl written in Ruby. 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."
   spec.homepage      = 'http://eterry1388.github.io/pritunl_api_client'
   spec.license       = 'MIT'
 
@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'byebug'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pritunl_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Eric Terry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2015-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -66,11 +66,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'API client for Pritunl written in Ruby. 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.'
+  here: https://pritunl.com/api.html. I am not affiliated with Pritunl.'
 email:
 - eterry1388@aol.com
 executables: