cloudpassage 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eaf01ba7692899c65548276989de4dc78c0f41a4
-  data.tar.gz: 7d3c5caafdcbbfaccb6d773cbb237a96d70d73ee
+  metadata.gz: 2f885d2347066b179712e43dae23e79c82f8a2f5
+  data.tar.gz: b0259a907cc18cdcfce0233ee452fb1465a2ad4e
 SHA512:
-  metadata.gz: 99122f68fa2bcefd3765a5d650d4b719c27759bbb3081c2fa7e6e2fdaeca6c668e283b278e30ba80e9ec2bf38dea3392b64a4687cb0279222993ac26328cbee6
-  data.tar.gz: f664529308ac909bcab4c4d14b72c46a3a91295aa43b6d508a10d708e4d43384daea2d7ffa7c0285b6eecbd5c43642e47401cf60697814dd384dff24cdf1df62
+  metadata.gz: abd4ddf4ef561a50d17ca25fb4cf62e84edff52f95066313585c9c92a62460edcd20ba46a7dfd6d478a52e1c2286c031cce42b6a1f5a906d2a014ca4bbde7319
+  data.tar.gz: 167df14e02f8736cd0d58023c0372ec3d5d0a579c9f46dbcd3a8950de805ee476f0c1ab1017dd10c107c98262bc6add2289cc7081c309c15ca5c68831bcc7a56

data/.gitignore

@@ -1,3 +1,4 @@
+.vendor
 vendor
 .idea
 *.gem

data/.pryrc

@@ -1,2 +1,2 @@
 require 'cloudpassage/pry'
-include Cloudpassage::Pry
+extend Cloudpassage::Pry

data/README.md

@@ -49,6 +49,18 @@ Or install it yourself as:
   puts api.servers.all[0].accounts.all
   puts api.servers.all[0].issues.all
   puts api.server_groups.all[0].groups.all
+
+  # Add/move a server to a group (groups are case-sensitive)
+  api.servers.get('some_id').group='some_group_id'
+
+  # List servers by passing in state (missing, deactivated, active)
+  api.servers.filter(:state=>'missing')
+
+  # Delete a server permanently
+  api.servers.get('id').destroy
+
+  # Retire a 'inactive' server
+  api.servers.get('id').retire
       
   # Get specific things.
   puts api.file_integrity_policies.get('file_integrity_policy_id').data.to_json

data/lib/cloudpassage/api.rb

@@ -1,11 +1,13 @@
 module Cloudpassage
 
-  BASE_URL='https://api.cloudpassage.com/v1/'
+  BASE_URL = 'https://api.cloudpassage.com/v1/'
 
+  # Obtains a new API object by generating a token using id + secret.
   def self.api(id, secret)
     Api.new(self.token(id, secret))
   end
 
+  # Interface to all cloudpassage stuff
   class Api
     attr_reader :token, :base_resource
 
@@ -14,42 +16,52 @@ module Cloudpassage
       @base_resource = RestClient::Resource.new(BASE_URL)
     end
 
+    # Configuration policies
     def configuration_policies
       Policies.new(token, base_resource['policies'])
     end
 
+    # Events
     def events
       Events.new(token, base_resource['events'])
     end
 
+    # File integrity policies
     def file_integrity_policies
       FimPolicies.new(token, base_resource['fim_policies'])
     end
 
+    # Firewall interfaces
     def firewall_interfaces
       FirewallInterfaces.new(token, base_resource['firewall_interfaces'])
     end
 
+    # Firewall policies
     def firewall_policies
       FirewallPolicies.new(token, base_resource['firewall_policies'])
     end
 
+    # Firewall services
     def firewall_services
       FirewallServices.new(token, base_resource['firewall_services'])
     end
 
+    # Firewall zones
     def firewall_zones
       FirewallZones.new(token, base_resource['firewall_zones'])
     end
 
+    # Servers
     def servers
       Servers.new(token, base_resource['servers'])
     end
 
+    # Groups
     def server_groups
       Groups.new(token, base_resource['groups'])
     end
 
+    # Users
     def users
       Users.new(token, base_resource['users'])
     end

data/lib/cloudpassage/base.rb

@@ -1,6 +1,8 @@
 require 'wait'
 
 module Cloudpassage
+
+  # Default options to use when waiting.
   def self.wait_options
     {
       :attempts => 50000,
@@ -10,6 +12,7 @@ module Cloudpassage
     }
   end
 
+  # Base class representing cloudpassage objects.
   class Base
     def initialize(token, base_resource, data=nil)
       @token = token
@@ -17,6 +20,8 @@ module Cloudpassage
       @data = data
     end
 
+    # Return data from sending http GET to underlying resource.
+    # Uses cached value if resource has been retrieved already.
     def data
       if @data.nil?
         @data = JSON.parse(@base_resource.get(headers), :symbolize_names=>true)[object_symbol]
@@ -33,6 +38,7 @@ module Cloudpassage
       {'Authorization'=>"Bearer #{@token}"}
     end
 
+    # If method is missing, try to pass through to underlying data hash.
     def method_missing(sym, *args, &block)
       if (data && data[sym])
         data[sym]
@@ -58,9 +64,12 @@ module Cloudpassage
     def object_symbol
       class_name = self.class.name
       index = class_name.rindex(/::/)
-      class_name[index+2..-1].underscore.to_sym
+      class_name[index + 2 .. -1].underscore.to_sym
     end
 
+    # Wait for block to evaluate to true.
+    # If specified, options can be used to override default options.
+    # Options should conform to https://rubygems.org/gems/wait
     def wait_for(options={}, &block)
       Wait.new(Cloudpassage::wait_options.merge(options)).until do
         reload

data/lib/cloudpassage/cloudpassage.rb

@@ -5,6 +5,7 @@ require 'json'
 module Cloudpassage
   RestClient.proxy = ENV['HTTPS_PROXY'] if ENV['HTTPS_PROXY'].to_s.length > 0
 
+  # Obtain an oauth token using id and secret
   def self.token(client_id, client_secret)
     client = OAuth2::Client.new(client_id, client_secret,
                                 :connection_opts => { :proxy => ENV['HTTPS_PROXY'] },
@@ -16,11 +17,12 @@ end
 
 # Add camel-to-snake-case conversion
 class String
+
+  # returns camel-case representation of snake-case string.
   def underscore
     self.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
-        downcase
+        gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+        gsub(/([a-z\d])([A-Z])/, '\1_\2').
+        tr('-', '_').downcase
   end
 end

data/lib/cloudpassage/collection.rb

@@ -1,11 +1,11 @@
 require 'json'
 
 module Cloudpassage
+
+  # Collections of objects.
   module Collection
     def all
-      data.map{|i|
-        get(i[:id], i)
-      }
+      data.map { |i| get(i[:id], i) }
     end
 
     def get(id, data=nil)

data/lib/cloudpassage/events.rb

@@ -1,4 +1,6 @@
 module Cloudpassage
+
+  # Events
   class Events < Base
     include Collection
 

data/lib/cloudpassage/file_integrity_baselines.rb

@@ -1,4 +1,5 @@
 module Cloudpassage
+  # File Interity Baselines
   class FileIntegrityBaselines < Base
     include Collection
 

data/lib/cloudpassage/fim_policies.rb

@@ -1,4 +1,5 @@
 module Cloudpassage
+  # FimPolicies
   class FimPolicies < Base
     include Collection
 

data/lib/cloudpassage/firewall_interfaces.rb

@@ -1,4 +1,6 @@
 module Cloudpassage
+
+  # Firewall Interfaces
   class FirewallInterfaces < Base
     include Collection
     def singleton_class

data/lib/cloudpassage/firewall_policies.rb

@@ -1,4 +1,6 @@
 module Cloudpassage
+
+  # Firewall Policies
   class FirewallPolicies < Base
     include Collection
 

data/lib/cloudpassage/firewall_rules.rb

@@ -1,4 +1,6 @@
 module Cloudpassage
+
+  # Firewall Rules
   class FirewallRules < Base
     include Collection
 

data/lib/cloudpassage/firewall_services.rb

@@ -1,4 +1,6 @@
 module Cloudpassage
+
+  # Firewall Services
   class FirewallServices < Base
     include Collection
 

data/lib/cloudpassage/firewall_zones.rb

@@ -1,4 +1,6 @@
 module Cloudpassage
+
+  # Firewall Zones
   class FirewallZones < Base
     include Collection
 

data/lib/cloudpassage/groups.rb

@@ -1,4 +1,6 @@
 module Cloudpassage
+
+  # Groups
   class Groups < Base
     include Collection
     def singleton_class

data/lib/cloudpassage/policies.rb

@@ -1,4 +1,6 @@
 module Cloudpassage
+
+  # Policies
   class Policies < Base
     include Collection
 

data/lib/cloudpassage/pry.rb

@@ -1,21 +1,22 @@
 require 'yaml'
 require 'cloudpassage'
 
+# Module to make it easy to use stuff from pry (or any sort of interactive debugger)
 module Cloudpassage::Pry
   def cloudpassage(type)
-    type_section = section(type)
+    type_section = Cloudpassage::Pry::section(type)
     Cloudpassage::Api.new(Cloudpassage.token(type_section['id'], type_section['secret']))
   end
 
-  def section(type)
-    yaml[type.to_s]
+  def self.section(type)
+    yaml.fetch(type.to_s)
   end
 
-  def yaml
-    @@yaml ||= YAML.load(File.read(config_file))
+  def self.yaml
+    @yaml ||= YAML.load(File.read(config_file))
   end
 
-  def config_file
+  def self.config_file
     ENV.fetch('CLOUDPASSAGE_CONFIG_FILE', "#{ENV['HOME']}/.cloudpassagerc")
   end
 end

data/lib/cloudpassage/servers.rb

@@ -2,9 +2,15 @@ module Cloudpassage
   class Servers < Base
     include Collection
 
+    def filter(options={})
+        servers = JSON.parse(@base_resource.get(headers.merge(:params=>options)), :symbolize_names=>true)[:servers]
+        servers.map { |i| get(i[:id], i) }
+    end
+
     def singleton_class
       Server
     end
+
   end
 
   class Server < Single
@@ -21,6 +27,17 @@ module Cloudpassage
       Accounts.new(self, @token, @base_resource['accounts'])
     end
 
+    def retire
+      # retire a 'inactive' server
+      payload = {"server"=>{"retire"=>true}}
+      @base_resource.put(payload.to_json, headers.merge(:content_type => :json))
+    end
+
+    def group=(group_id)
+      # add server to group
+      payload = {"server"=>{"group_id"=>group_id}}
+      @base_resource.put(payload.to_json, headers.merge(:content_type => :json))
+    end
 
     def commands
       Commands.new(@token, @base_resource['commands'])
@@ -31,6 +48,7 @@ module Cloudpassage
     end
   end
 
+  # Accounts on a server
   class Accounts < Base
     include Collection
 
@@ -44,9 +62,12 @@ module Cloudpassage
     end
 
     def all
-      data.map{|i| get(i[:username], i)}
+      data.map { |i| get(i[:username], i) }
     end
 
+    # Creates username, in the given group.
+    # If opts[:password] is specified, that password will be used.
+    # Otherwise, password will be generated.
     def create(username, groups = '', opts = {})
       payload = {'account' => {
         :username => username,

data/lib/cloudpassage/single.rb

@@ -1,6 +1,8 @@
 require  'json'
 
 module Cloudpassage
+
+  # Single objects.
   class Single < Base
 
     attr_reader :id
@@ -13,5 +15,9 @@ module Cloudpassage
     def get
       @base_resource.get(headers)
     end
+
+    def destroy
+      @base_resource.delete(headers)
+    end
   end
 end

data/lib/cloudpassage/users.rb

@@ -1,4 +1,5 @@
 module Cloudpassage
+  # Users
   class Users < Base
     include Collection
 

data/lib/cloudpassage/version.rb

@@ -1,3 +1,4 @@
 module Cloudpassage
-  VERSION = '0.0.4'
+  # Version
+  VERSION = '0.0.6'
 end

data/spec/api_spec.rb

@@ -1,4 +1,5 @@
 require File.join(File.dirname(__FILE__), '..', 'lib', 'cloudpassage')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'cloudpassage', 'pry')
 require 'rspec'
 
 module Cloudpassage
@@ -6,8 +7,7 @@ module Cloudpassage
     attr_reader :api
 
     before :each do
-      token = Cloudpassage.token(ENV.fetch('CLOUDPASSAGE_ID'), ENV.fetch('CLOUDPASSAGE_SECRET'))
-      @api =  Cloudpassage::Api.new(token)
+      @api = Cloudpassage::Pry::cloudpassage(:test)
     end
 
     def self.collections

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudpassage
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - mshea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-11 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake