pritunl_api_client 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8893ac808d0c01beb6358428c5b63d8527463d55
-  data.tar.gz: 626352f2e452a8d8eb162da04258d6866204acc2
+  metadata.gz: 9e7aab97574ccbc72cffee7ab7e38fff8d6cc087
+  data.tar.gz: ff948fea79a2d01158132c87a66004dc56121066
 SHA512:
-  metadata.gz: 3d2cd77747daec9516ef5994738461a89ce87988d66616115f3b3f40a3fb626c855e569dfae3e158d356b755a667a3a7fc3a8682d91d5c5393736382d5bba4d3
-  data.tar.gz: 989fc53e24ddd513854465ca42cbe318e87e5f62dd4131126e8e4f3df5b9c7d765d20232c10a05f83fb7e9b6cdac94e4119cfab19095f11c233e919035f2dbd5
+  metadata.gz: 93353f991868e733cf931697079040de1cec0de4e1c62a8ba95db34abc1d1ec2efb85f7228ee5f63b991c4b264457d5277fd092ec959b1d3dbabf709dfc15a56
+  data.tar.gz: 91da34ec454609c5a5a23abe3a83f71446e24e5a2d7c0005f67133307ae1df5525b9b9bac84918f9989a9b488a0a1dfee89a6e939228c7dc48700a34ccb33a1a

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v1.4.0 (2016-02-17)
+* Can now download OVPN key file directly from API (rather than just ZIP and TAR key files)
+* Ability to get key files content directly (rather than just download the key files)

data/README.md

@@ -1,6 +1,9 @@
 # Pritunl API Client
 
 [![Gem Version](https://badge.fury.io/rb/pritunl_api_client.svg)](https://badge.fury.io/rb/pritunl_api_client)
+![](http://ruby-gem-downloads-badge.herokuapp.com/pritunl_api_client?type=total)
+[![Inline docs](http://inch-ci.org/github/eterry1388/pritunl_api_client.svg?branch=master)](http://inch-ci.org/github/eterry1388/pritunl_api_client)
+[![Dependency Status](https://gemnasium.com/eterry1388/pritunl_api_client.svg)](https://gemnasium.com/eterry1388/pritunl_api_client)
 
 API client for Pritunl written in Ruby.
 
@@ -315,18 +318,33 @@ require 'pritunl_api_client'
 
 ## Keys
 
+If you omit the `path` parameter on any of the `key` APIs below, the file content will be directly returned
+from the method rather than to a downloaded file.
+
+### Download a users key.
+
+```ruby
+@pritunl.key.download( organization_id: org['id'], user_id: user['id'], path: 'output.ovpn' )
+```
+
 ### 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.
+### Download a users key zip archive.
 
 ```ruby
 @pritunl.key.download_zip( organization_id: org['id'], user_id: user['id'], path: 'output.zip' )
 ```
 
+### Download a users onc key Chromebook profile zip archive.
+
+```ruby
+@pritunl.key.download_chromebook_profile( organization_id: org['id'], user_id: user['id'], path: 'output.zip' )
+```
+
 ### Generate a temporary url to download a users key archive.
 
 ```ruby
@@ -544,8 +562,14 @@ PritunlApiClient
     Generate two-step auth for user
     Delete user
   PritunlApiClient::Key
+    Download key
+    Get key
+    Download tar key
     Get tar key
+    Download zip key
     Get zip key
+    Download chromebook profile onc zip key
+    Get chromebook profile onc zip key
     Get key temporary url
   PritunlApiClient::Server
     Create server
@@ -564,8 +588,8 @@ PritunlApiClient
     Get all settings
     Update settings
 
-Finished in 1 minute 14.14 seconds (files took 0.12978 seconds to load)
-32 examples, 0 failures
+Finished in 1 minute 11.62 seconds (files took 0.17043 seconds to load)
+38 examples, 0 failures
 ```
 
 ## License

data/lib/pritunl_api_client/key.rb

@@ -8,14 +8,37 @@ module PritunlApiClient
       @api = api
     end
 
+    # Download a users key
+    #
+    # @note User organization must be attached to a server
+    # @param organization_id [String]
+    # @param user_id [String]
+    # @param path [String] Local path to save downloaded file (if omitted, file content fill be returned)
+    # @raise [StandardError] if user or servers cannot be found
+    # @return [String] Local path to downloaded file or file contents if 'path' was omitted
+    def download( organization_id:, user_id:, path: nil )
+      temporary_url_id = temporary_url( organization_id: organization_id, user_id: user_id )['id']
+      all_users = @api.get( "/user/#{organization_id}" )
+      user = all_users.find { |user| user['id'] == user_id }
+      fail StandardError, 'Could not find user!' unless user
+      servers = user['servers']
+      fail StandardError, 'Could not find servers attached to user!' unless servers && servers.count >= 1
+      server_id = servers.first['id']
+      data = @api.get( "/key/#{temporary_url_id}/#{server_id}.key" )
+      return data unless path
+      File.write( path, data.force_encoding( 'utf-8' ) )
+      path
+    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: )
+    # @param path [String] Local path to save downloaded file (if omitted, file content fill be returned)
+    # @return [String] Local path to downloaded file or file contents if 'path' was omitted
+    def download_tar( organization_id:, user_id:, path: nil )
       data = @api.get( "/key/#{organization_id}/#{user_id}.tar" )
+      return data unless path
       File.write( path, data.force_encoding( 'utf-8' ) )
       path
     end
@@ -24,10 +47,11 @@ module PritunlApiClient
     #
     # @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: )
+    # @param path [String] Local path to save downloaded file (if omitted, file content fill be returned)
+    # @return [String] Local path to downloaded file or file contents if 'path' was omitted
+    def download_zip( organization_id:, user_id:, path: nil )
       data = @api.get( "/key/#{organization_id}/#{user_id}.zip" )
+      return data unless path
       File.write( path, data.force_encoding( 'utf-8' ) )
       path
     end
@@ -36,10 +60,11 @@ module PritunlApiClient
     #
     # @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: )
+    # @param path [String] Local path to save downloaded file (if omitted, file content fill be returned)
+    # @return [String] Local path to downloaded file or file contents if 'path' was omitted
+    def download_chromebook_profile( organization_id:, user_id:, path: nil )
       data = @api.get( "/key_onc/#{organization_id}/#{user_id}.zip" )
+      return data unless path
       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.2.0'
+  VERSION = '1.4.0'
 end

data/pritunl_api_client.gemspec

@@ -15,7 +15,6 @@ Gem::Specification.new do |spec|
   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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pritunl_api_client
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Eric Terry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -85,20 +85,17 @@ description: 'API client for Pritunl written in Ruby. Pritunl is a distributed e
   here: https://pritunl.com/api.html. I am not affiliated with Pritunl.'
 email:
 - eterry1388@aol.com
-executables:
-- console
-- setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - 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
@@ -128,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Pritunl Ruby API Client

data/bin/console

@@ -1,14 +0,0 @@
-#!/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

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here