code42 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bf8ccbbf30229f5782e6820c7e65d7a231f2543
-  data.tar.gz: 957d1a88845196fb072e784ff74378638f497c65
+  metadata.gz: b135cab63fe09fc1040dedc78ea9858c194af1fe
+  data.tar.gz: 84474930341cd9b4434fbdfa02b7beb889d7f3aa
 SHA512:
-  metadata.gz: e0b5aaa0a70a0c2e253d009c78aec1f8e6268e85678fa66b3913b422285de5de3f60f761d2804e7374f0359f4749b536a27edd9cc8125440cd11341ffd446ae0
-  data.tar.gz: 43ccc2d3d9727797a2fe5ba31b3b6edccbeca692f527b8659f05c87d793a6e9504e35441b0aae94606dc24c1bc0ad7c82c8d4da987b85926876143d544d62ad2
+  metadata.gz: 3e9d3c351cfa7088a79adcc35bb227e20f677bd8fbb73833ee2cf5e7b47ddbcef5d2078d6cf44d81610ee954c2e50bd04601d0bea20dce7ec54163cddf767c12
+  data.tar.gz: 6cca4e1cf4dce1645ef2287533496802c498f1b422f8882b7f9fdf6d97d565688d4684cb26f84073fb936f60d542f3e951a69de8f26ed3e1521c5963078028c8

data/lib/code42.rb

@@ -27,6 +27,7 @@ require 'code42/product_license'
 require 'code42/server_settings'
 require 'code42/destination'
 require 'code42/server'
+require 'code42/server_env'
 require 'code42/server_connection_string'
 require 'code42/store_point'
 

data/lib/code42/api/destination.rb

@@ -1,8 +1,8 @@
 module Code42
   module API
     module Destination
-      def destinations
-        objects_from_response(Code42::Destination, :get, 'destinations', key: 'destinations')
+      def destinations(name = nil)
+        objects_from_response(Code42::Destination, :get, "destinations#{"?name=#{name}" if name}", key: 'destinations')
       end
 
       def destination(id)
@@ -11,7 +11,7 @@ module Code42
 
       def create_destination(attrs)
         response = post('Destination', attrs)
-        response && response['data'].is_a?(Array)
+        response['data'].first if response && response['data'].is_a?(Array)
       end
     end
   end

data/lib/code42/api/server.rb

@@ -6,9 +6,9 @@ module Code42
       end
 
       def server(id, params = {})
-        if id.is_a? Fixnum
+        if id.eql? 'this' or id.is_a? Fixnum
           object_from_response(Code42::Server, :get, "server/#{id}", params)
-        elsif id.is_a? String
+        else
           servers(params.merge(q: id)).first
         end
       end

data/lib/code42/api/server_env.rb

@@ -0,0 +1,9 @@
+module Code42
+  module API
+    module ServerEnv
+      def server_env(params = {})
+        object_from_response(Code42::ServerEnv, :get, 'ServerEnv', params)
+      end
+    end
+  end
+end

data/lib/code42/client.rb

@@ -1,3 +1,4 @@
+require 'faraday'
 require 'forwardable'
 require 'json'
 Dir[File.dirname(__FILE__) + '/api/*.rb'].each { |file| require file }
@@ -13,6 +14,7 @@ module Code42
     include Code42::API::ServerSettings
     include Code42::API::Destination
     include Code42::API::Server
+    include Code42::API::ServerEnv
     include Code42::API::PasswordReset
     include Code42::API::StorePoint
     include Code42::API::Diagnostic
@@ -117,19 +119,20 @@ module Code42
     end
 
     def get(path, data = {}, &block)
-      make_request(:get, path, data, &block)
+      # Spaces need to be URI encoded to +.
+      make_request(:get, path.gsub(/ +/, '+'), data, &block)
     end
 
     def post(path, data = {}, &block)
-      make_request(:post, path, data, &block)
+      make_request(:post, path.gsub(/ +/, '+'), data, &block)
     end
 
     def put(path, data = {}, &block)
-      make_request(:put, path, data, &block)
+      make_request(:put, path.gsub(/ +/, '+'), data, &block)
     end
 
     def delete(path, data = {}, &block)
-      make_request(:delete, path, data, &block)
+      make_request(:delete, path.gsub(/ +/, '+'), data, &block)
     end
   end
 end

data/lib/code42/connection.rb

@@ -3,6 +3,7 @@ require 'faraday'
 require 'faraday_middleware'
 require 'logger'
 require 'code42/error'
+require 'code42/faraday_middleware/parse_server_env'
 
 module Code42
   class Connection
@@ -46,6 +47,9 @@ module Code42
         f.adapter  :net_http
 
         f.response :json
+
+        # Custom Faraday Middleware parser to parse the javascript returned from the /api/ServerEnv api.
+        f.use Code42::FaradayMiddleware::ParseServerEnv
       end
     end
 

data/lib/code42/faraday_middleware/parse_server_env.rb

@@ -0,0 +1,32 @@
+require 'faraday_middleware/response_middleware'
+
+module Code42
+  module FaradayMiddleware
+    class ParseServerEnv < ::FaradayMiddleware::ResponseMiddleware
+      dependency 'json'
+
+      define_parser do |body|
+        new_body = body.clone
+        new_body.gsub! "'", '"' # Remove single-quotes and replace with double-quotes. JSON parser cannot parse single quotes.
+        new_body.gsub! /(\w+):/, '"\1":' # Surround keys with double-quotes.
+        new_body.sub! 'window.serverEnv = ', '' # Trim off variable assignment.
+        new_body.chomp! ";\n" # Trim off tailing semicolon and newline characters.
+
+        # noinspection RubyStringKeysInHashInspection
+        begin
+          { 'data' => ::JSON.parse(new_body) }
+        rescue
+          body
+        end
+      end
+
+      SERVER_ENV_PATH = '/api/ServerEnv'
+      MIME_TYPE = 'text/javascript'
+
+      def parse_response?(env)
+        # noinspection RubyResolve
+        SERVER_ENV_PATH.casecmp(env.url.path) == 0 and env.response_headers['content-type'].include? MIME_TYPE
+      end
+    end
+  end
+end

data/lib/code42/server_env.rb

@@ -0,0 +1,34 @@
+module Code42
+  class ServerEnv < Resource
+    attribute :version
+    attribute :product_version
+    attribute :client_product_version
+    attribute :sp_client_product_version
+    attribute :commerce_version
+
+    attribute :cluster_type
+    attribute :server_type
+
+    attribute :env
+    attribute :constants
+
+    attribute :server_id
+    attribute :server_guid
+    attribute :cluster_server_id
+
+    attribute :port_prefix
+    attribute :sso_auth_enabled
+    attribute :note
+
+    attribute :ssl
+    attribute :has_mlk
+    attribute :has_logged_in
+    attribute :default_admin_password
+    attribute :query_limited
+    attribute :stats_enabled
+    attribute :secure_keystore_locked
+    attribute :http_port
+    attribute :https_port
+    attribute :locale
+  end
+end

data/lib/code42/version.rb

@@ -1,3 +1,3 @@
 module Code42
-  VERSION = "0.2.7"
+  VERSION = '0.2.8'
 end

data/spec/cassettes/Code42_Client/_server/returns_a_server_with_this.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://10.10.47.82:4280/api/server/this
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Authorization:
+      - Basic YWRtaW46YWRtaW4=
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      Content-Location:
+      - http://10.10.47.82:4280/api/v1/server/this
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(7.6.3.v20120416)
+    body:
+      encoding: UTF-8
+      string: '{"metadata":{"timestamp":"2013-09-11T13:12:18.952-05:00","params":{}},"data":{"serverId":3,"guid":"600624193549107457","serverName":"more-03","type":"SERVER","version":"3.6.1.3","online":true,"outOfDate":false,"acceptingInboundBackup":"ALL","balancingData":"NONE","acceptingNewComputers":"ALL","dbEmpty":true,"clusterServerId":1,"destinationId":2,"destinationName":"CrashPlan
+        PROe Server","providerDestinationName":null,"primaryAddress":"10.10.47.82:4282","secondaryAddress":null,"websiteHost":"http://10.10.47.82:4280","storePointCount":1,"totalBytes":19674116096,"usedBytes":3819704320,"usedPercentage":19.0,"freeBytes":15854411776,"freePercentage":81.0,"coldBytes":0,"coldPercentageOfUsed":0.0,"coldPercentageOfTotal":0.0,"archiveBytes":0,"selectedBytes":0,"remainingBytes":0,"inboundBandwidth":0,"outboundBandwidth":0,"orgCount":0,"userCount":0,"licensedUserCount":0,"computerCount":0,"backupComputerCount":0,"onlineComputerCount":0,"backupSessionCount":0}}'
+    http_version: 
+  recorded_at: Wed, 11 Sep 2013 18:31:08 GMT
+recorded_with: VCR 2.5.0

data/spec/code42/client_spec.rb

@@ -34,11 +34,16 @@ describe Code42::Client, :vcr do
   end
 
   describe '#server' do
-    it 'returns a server' do
+    it 'returns a server with id' do
       server = client.server(3)
       server.should be_a(Code42::Server)
       server.id.should == 3
     end
+    it 'returns a server with this' do
+      server = client.server('this')
+      server.should be_a(Code42::Server)
+      server.id.should == 3
+    end
   end
 
   describe '#update_server_settings' do

data/spec/code42/parse_server_env_spec.rb

@@ -0,0 +1,110 @@
+describe Code42::FaradayMiddleware::ParseServerEnv do
+  describe '#parse' do
+    let(:raw_javascript) do
+      <<-JAVASCRIPT.gsub(/^ +/, '')
+        window.serverEnv = {
+        \tversion: 1427864400430,
+        \tproductVersion: "4.3.0",
+        \tclientProductVersion: "4.2.0",
+        \tspClientProductVersion: "4.2.0",
+        \tcommerceVersion: "",
+
+        \tclusterType: {
+        \t\tconsumer: false,
+        \t\tbusiness: false,
+        \t\tenterprise: true
+        \t},
+
+        \tserverType: {
+        \t\tmaster: true,
+        \t\tstorage: false
+        \t},
+
+        \tenv: {
+        \t\tdev: true,
+        \t\tprd: false,
+        \t\tstg: false,
+        \t\tbeta: false
+        \t},
+
+        \tconstants: {
+        \t\tcpOrgId: 42,
+        \t\tproOrgId: 5
+        \t},
+
+        \tserverId: 3,
+        \tserverGuid: '7201',
+        \tclusterServerId: 1,
+        \tportPrefix: 72,
+        \tssoAuthEnabled: false,
+
+        \tNOTE: "ssl, queryLimited, hasLoggedIn, and defaultAdminPassword may/will change after login so this information should only be used on login or shortly after",
+        \tssl: true,
+        \thasMlk: true,
+        \thasLoggedIn: true,
+        \tdefaultAdminPassword: true,
+        \tqueryLimited: false,
+        \tstatsEnabled: true,
+        \tsecureKeystoreLocked: false,
+        \thttpPort: 7280,
+        \thttpsPort: 7285,
+        \tlocale: "en_US"
+        };
+      JAVASCRIPT
+    end
+    let(:expected_json) do
+      JSON.parse <<-JSON
+      {
+        "data": {
+          "version": 1427864400430,
+          "productVersion": "4.3.0",
+          "clientProductVersion": "4.2.0",
+          "spClientProductVersion": "4.2.0",
+          "commerceVersion": "",
+          "clusterType":
+            {
+              "consumer": false,
+              "business": false,
+              "enterprise": true
+            },
+          "serverType":
+            {
+              "master": true,
+              "storage": false
+            },
+          "env":
+            {
+              "dev": true, "prd": false, "stg": false, "beta": false
+            },
+          "constants":
+            {
+              "cpOrgId": 42,
+              "proOrgId": 5
+            },
+          "serverId": 3,
+          "serverGuid": "7201",
+          "clusterServerId": 1,
+          "portPrefix": 72,
+          "ssoAuthEnabled": false,
+          "NOTE": "ssl, queryLimited, hasLoggedIn, and defaultAdminPassword may/will change after login so this information should only be used on login or shortly after",
+          "ssl": true,
+          "hasMlk": true,
+          "hasLoggedIn": true,
+          "defaultAdminPassword": true,
+          "queryLimited": false,
+          "statsEnabled": true,
+          "secureKeystoreLocked": false,
+          "httpPort": 7280,
+          "httpsPort": 7285,
+          "locale": "en_US"
+        }
+      }
+      JSON
+    end
+
+    it 'should parse valid javascript into a valid json object' do
+      json = Code42::FaradayMiddleware::ParseServerEnv.new.parse raw_javascript
+      expect(json).to eql expected_json
+    end
+  end
+end

data/spec/code42/server_env_spec.rb

@@ -0,0 +1,56 @@
+describe Code42::ServerEnv do
+  describe '#deserialize_and_initialize' do
+    let(:response_data) do
+      JSON.parse <<-JSON
+      {
+        "version": 1427864400430,
+        "productVersion": "4.3.0",
+        "clientProductVersion": "4.2.0",
+        "spClientProductVersion": "4.2.0",
+        "commerceVersion": "",
+        "clusterType":
+          {
+            "consumer": false,
+            "business": false,
+            "enterprise": true
+          },
+        "serverType":
+          {
+            "master": true,
+            "storage": false
+          },
+        "env":
+          {
+            "dev": true, "prd": false, "stg": false, "beta": false
+          },
+        "constants":
+          {
+            "cpOrgId": 42,
+            "proOrgId": 5
+          },
+        "serverId": 3,
+        "serverGuid": "7201",
+        "clusterServerId": 1,
+        "portPrefix": 72,
+        "ssoAuthEnabled": false,
+        "NOTE": "ssl, queryLimited, hasLoggedIn, and defaultAdminPassword may/will change after login so this information should only be used on login or shortly after",
+        "ssl": true,
+        "hasMlk": true,
+        "hasLoggedIn": true,
+        "defaultAdminPassword": true,
+        "queryLimited": false,
+        "statsEnabled": true,
+        "secureKeystoreLocked": false,
+        "httpPort": 7280,
+        "httpsPort": 7285,
+        "locale": "en_US"
+      }
+      JSON
+    end
+
+    it 'should serialize json object into a valid ServerEnv object' do
+      server_env = Code42::ServerEnv.deserialize_and_initialize(response_data)
+      expect(server_env.product_version).to eql '4.3.0'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code42
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Code 42
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-05 00:00:00.000000000 Z
+date: 2015-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -140,6 +140,7 @@ files:
 - lib/code42/api/role.rb
 - lib/code42/api/server.rb
 - lib/code42/api/server_connection_string.rb
+- lib/code42/api/server_env.rb
 - lib/code42/api/server_settings.rb
 - lib/code42/api/store_point.rb
 - lib/code42/api/token.rb
@@ -152,6 +153,7 @@ files:
 - lib/code42/destination.rb
 - lib/code42/diagnostic.rb
 - lib/code42/error.rb
+- lib/code42/faraday_middleware/parse_server_env.rb
 - lib/code42/org.rb
 - lib/code42/permission.rb
 - lib/code42/ping.rb
@@ -161,6 +163,7 @@ files:
 - lib/code42/role_collection.rb
 - lib/code42/server.rb
 - lib/code42/server_connection_string.rb
+- lib/code42/server_env.rb
 - lib/code42/server_settings.rb
 - lib/code42/settings.rb
 - lib/code42/store_point.rb
@@ -195,7 +198,8 @@ files:
 - spec/cassettes/Code42_Client/_reset_password/when_sending_a_username/behaves_like_reset_password/is_successful.yml
 - spec/cassettes/Code42_Client/_reset_password/when_sending_a_view_url/behaves_like_reset_password/is_successful.yml
 - spec/cassettes/Code42_Client/_roles/returns_an_enumerable.yml
-- spec/cassettes/Code42_Client/_server/returns_a_server.yml
+- spec/cassettes/Code42_Client/_server/returns_a_server_with_id.yml
+- spec/cassettes/Code42_Client/_server/returns_a_server_with_this.yml
 - spec/cassettes/Code42_Client/_server_connection_string/returns_a_connection_string.yml
 - spec/cassettes/Code42_Client/_server_settings/returns_a_server_settings_object.yml
 - spec/cassettes/Code42_Client/_servers/returns_an_array_of_servers.yml
@@ -224,11 +228,13 @@ files:
 - spec/code42/connection_spec.rb
 - spec/code42/extension_spec.rb
 - spec/code42/org_spec.rb
+- spec/code42/parse_server_env_spec.rb
 - spec/code42/ping_spec.rb
 - spec/code42/product_license_spec.rb
 - spec/code42/resource_spec.rb
 - spec/code42/role_spec.rb
 - spec/code42/server_connection_string_spec.rb
+- spec/code42/server_env_spec.rb
 - spec/code42/server_spec.rb
 - spec/code42/settings_spec.rb
 - spec/code42/store_point_spec.rb
@@ -266,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: '...'
@@ -298,7 +304,8 @@ test_files:
 - spec/cassettes/Code42_Client/_reset_password/when_sending_a_username/behaves_like_reset_password/is_successful.yml
 - spec/cassettes/Code42_Client/_reset_password/when_sending_a_view_url/behaves_like_reset_password/is_successful.yml
 - spec/cassettes/Code42_Client/_roles/returns_an_enumerable.yml
-- spec/cassettes/Code42_Client/_server/returns_a_server.yml
+- spec/cassettes/Code42_Client/_server/returns_a_server_with_id.yml
+- spec/cassettes/Code42_Client/_server/returns_a_server_with_this.yml
 - spec/cassettes/Code42_Client/_server_connection_string/returns_a_connection_string.yml
 - spec/cassettes/Code42_Client/_server_settings/returns_a_server_settings_object.yml
 - spec/cassettes/Code42_Client/_servers/returns_an_array_of_servers.yml
@@ -327,11 +334,13 @@ test_files:
 - spec/code42/connection_spec.rb
 - spec/code42/extension_spec.rb
 - spec/code42/org_spec.rb
+- spec/code42/parse_server_env_spec.rb
 - spec/code42/ping_spec.rb
 - spec/code42/product_license_spec.rb
 - spec/code42/resource_spec.rb
 - spec/code42/role_spec.rb
 - spec/code42/server_connection_string_spec.rb
+- spec/code42/server_env_spec.rb
 - spec/code42/server_spec.rb
 - spec/code42/settings_spec.rb
 - spec/code42/store_point_spec.rb
@@ -349,4 +358,3 @@ test_files:
 - spec/fixtures/user_roles.json
 - spec/fixtures/validate_token.json
 - spec/spec_helper.rb
-has_rdoc: