code42 0.1.2 → 0.2.0

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store
+bin/*

data/README.md

@@ -6,42 +6,52 @@ A Ruby interface to the Code 42 API
 
 Add this line to your application's Gemfile:
 
-    gem 'code42'
+```ruby
+gem 'code42'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install code42
+```bash
+$ gem install code42
+```
 
 ## Configuration
 
-    client = Code42::Client.new(
-      host: 'staging.code42.com',
-      port: 1234,
-      https: true,
-      api_root: '/api/',
-      username: 'testuser',
-      password: 'letmein'
-    )
+```ruby
+client = Code42::Client.new(
+  host: 'staging.code42.com',
+  port: 1234,
+  https: true,
+  api_root: '/api/',
+  username: 'testuser',
+  password: 'letmein'
+)
+```
 
 ### Authentication
 
-```
+```ruby
 token = client.get_token
 ```
 
 Then you can pass this token for further requests:
 
-    client = Code42::Client.new(
-      host: 'staging.code42.com',
-      port: 1234,
-      https: true,
-      api_root: '/api/',
-      token: token
-    )
+```ruby
+client = Code42::Client.new(
+  host: 'staging.code42.com',
+  port: 1234,
+  https: true,
+  api_root: '/api/',
+  token: token
+)
+```
 
 ## Resources
 
@@ -49,85 +59,89 @@ Then you can pass this token for further requests:
 
 attributes:
 
-    [:id,
-     :uid,
-     :status,
-     :username,
-     :email,
-     :first_name,
-     :last_name,
-     :quota_in_bytes,
-     :org_id,
-     :org_uid,
-     :org_name,
-     :active,
-     :blocked,
-     :email_promo,
-     :invited,
-     :org_type,
-     :username_is_an_email,
-     :created_at,
-     :updated_at]
+```ruby
+[:id,
+ :uid,
+ :status,
+ :username,
+ :email,
+ :first_name,
+ :last_name,
+ :quota_in_bytes,
+ :org_id,
+ :org_uid,
+ :org_name,
+ :active,
+ :blocked,
+ :email_promo,
+ :invited,
+ :org_type,
+ :username_is_an_email,
+ :created_at,
+ :updated_at]
+```
 
 ### Org
 
 attributes:
 
-    [:id,
-     :uid,
-     :name,
-     :status,
-     :active,
-     :blocked,
-     :parent_id,
-     :type,
-     :external_id,
-     :hierarchy_counts,
-     :config_inheritance_counts,
-     :created_at,
-     :updated_at,
-     :registration_key,
-     :reporting,
-     :custom_config,
-     :settings,
-     :settings_inherited,
-     :settings_summary]
+```ruby
+[:id,
+ :uid,
+ :name,
+ :status,
+ :active,
+ :blocked,
+ :parent_id,
+ :type,
+ :external_id,
+ :hierarchy_counts,
+ :config_inheritance_counts,
+ :created_at,
+ :updated_at,
+ :registration_key,
+ :reporting,
+ :custom_config,
+ :settings,
+ :settings_inherited,
+ :settings_summary]
+```
 
 ## Usage
 
 ### Ping a host
 
-```
+```ruby
 success = client.ping.success?
 ```
 
 ### Fetch the currently authorized API user
 
-```
+```ruby
 user = client.user
 ```
 
-### Get the get a user by ID
+### Fetch a user by ID
 
-```
+```ruby
 user = client.user(42)
 ```
 
 ### Fetch the Org for the currently authorized API user
 
-```
+```ruby
 org = client.org
 ```
 
 ### Fetch a specific Org by ID
 
-```
+```ruby
 org = client.org(42)
 ```
 
 ### Validate a token
 
-```
+```ruby
 client.validate_token(token).valid?
 ```
 
@@ -149,6 +163,10 @@ https://github.com/code42/code42_api_ruby/wiki
 
 [@melissavoegeli](http://github.com/melissavoegeli)
 
+## Contributors
+
+[@jrmehle](http://github.com/jrmehle)
+
 # Code 42 README
 
 ## What is this?

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/code42.gemspec

@@ -12,12 +12,12 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{...}
   gem.homepage      = ""
 
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'webmock'
-  gem.add_development_dependency 'vcr'
-  gem.add_dependency 'faraday'
-  gem.add_dependency 'activesupport', '~> 3.2.0'
-  gem.add_dependency 'faraday_middleware'
+  gem.add_development_dependency 'rspec',   '~> 2.11.0'
+  gem.add_development_dependency 'webmock', '~> 1.11.0'
+  gem.add_development_dependency 'vcr',     '~> 2.4.0'
+  gem.add_dependency 'faraday',             '~> 0.8.7'
+  gem.add_dependency 'activesupport',       '~> 3.2.0'
+  gem.add_dependency 'faraday_middleware',  '~> 0.9.0'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/code42/api/computer.rb

@@ -0,0 +1,22 @@
+module Code42
+  module API
+    module Computer
+      ### Computers :get, :put  ###
+
+      # Returns one computer or http status 404
+      # @return [Code42::Computer] The requested computer
+      # @param id [String, Integer] A computer ID
+      def computer(id, params = {})
+        object_from_response(Code42::Computer, :get, "computer/#{id}", params)
+      end
+
+      # Returns a list of computers
+      # @return [Array] The list of computers
+      # @param params [Hash] A hash of valid search parameters for computers
+      def computers(params = {})
+        params.merge!(key: 'computers')
+        objects_from_response(Code42::Computer, :get, 'computer', params)
+      end
+    end
+  end
+end

data/lib/code42/api/org.rb

@@ -0,0 +1,60 @@
+module Code42
+  module API
+    module Org
+      ### Orgs :post, :get, :put, :delete ###
+
+      # Creates blue org as well as user for the org
+      # @return [Code42::Org] The created org
+      # @param attrs [Hash] A hash of attributes to assign to created org
+      # @example
+      #   client.create_org(:company => "test", :email => "test@test.com", :firstname => "test", :lastname => "test")
+      def create_pro_org(attrs = {})
+        object_from_response(Code42::Org, :post, "proOrgChannel", attrs)
+      end
+
+      # Creates an org
+      # @return [Code42::Org] The created org
+      # @param attrs [Hash] A hash of attributes to assign to created org
+      # @example
+      #   client.create_org(:name => 'Acme Org', :parent_id => 2)
+      def create_org(attrs = {})
+        object_from_response(Code42::Org, :post, "org", attrs)
+      end
+
+      # Returns information for a given org
+      # @return [Code42::Org] The requested org
+      # @param id [String, Integer] A code42 user ID
+      def org(id = "my", params = {})
+        object_from_response(Code42::Org, :get, "org/#{id}", params)
+      end
+
+      # Returns an org for a given name
+      # @return [Code42::Org] The requested org
+      # @param name [String] A Code42 org name
+      # FIXME: This needs to change when the API implements a better way.
+      def find_org_by_name(name)
+        search_orgs(name).select { |o| o.name == name }.first
+      end
+
+      # Searches orgs for a query string
+      # @return [Array] An array of matching orgs
+      # @param query [String] A string to search for
+      def search_orgs(query)
+        orgs(q: query)
+      end
+
+      # Returns a list of up to 100 orgs
+      # @return [Array] An array of matching orgs
+      # @param params [Hash] A hash of parameters to match results against
+      def orgs(params = {})
+        params.merge!(key: 'orgs')
+        objects_from_response(Code42::Org, :get, 'org', params)
+      end
+
+      def update_org(id = 'my', attrs = {})
+        object_from_response(Code42::Org, :put, "org/#{id}", attrs)
+      end
+
+    end
+  end
+end

data/lib/code42/api/role.rb

@@ -0,0 +1,24 @@
+module Code42
+  module API
+    module Role
+      ### Roles :post, :get ###
+
+      # Assigns a role to a user
+      # @return [Code42::Role] The assigned role
+      # @param attrs [Hash] A hash of attributes for assigning a user role
+      # @example
+      #   client.assign_role(:user_id => 2, :role_name => 'Admin')
+      def assign_role(attrs = {})
+        object_from_response(Code42::Role, :post, 'UserRole', attrs)
+      end
+
+      # Returns a list of roles for a given user
+      # @return [Code42::RoleCollection] A collection of matching roles
+      # @param id [String, Integer] The id of the user to return roles for
+      def user_roles(id = 'my')
+        collection_from_response(Code42::RoleCollection, Code42::Role, :get, "userRole/#{id}")
+      end
+    end
+  end
+end
+

data/lib/code42/api/token.rb

@@ -0,0 +1,32 @@
+module Code42
+  module API
+    module Token
+      ### Authentication With Tokens :post, :get, :delete ###
+
+      # Gets a token for the currently authorized user
+      def get_token
+        object_from_response(Code42::Token, :post, "authToken")
+      end
+
+      # Returns LoginToken and ServerUrl
+      # @return [CrashPlan::Token] Token to pass to ServerUrl's AuthToken resource
+      def get_login_token
+        object_from_response(Code42::Token, :post, "loginToken")
+      end
+
+      # Validates an authorization token
+      # @return [Code42::TokenValidation]
+      # @param token [Code42::Token, String] The token to validate
+      def validate_token(token)
+        object_from_response(Code42::TokenValidation, :get, "authToken/#{token.to_s}")
+      end
+
+      # Manually expires a token
+      # @param token [Code42::Token, String] A token to expire (leave blank to expire currently used token)
+      def delete_token(token = nil)
+        token = token || settings.token
+        delete "authToken/#{token.to_s}"
+      end
+    end
+  end
+end

data/lib/code42/api/user.rb

@@ -0,0 +1,72 @@
+module Code42
+  module API
+    module User
+      ### Users :post, :get ###
+
+      # Creates a user
+      # @return [Code42::User] The created user
+      # @param attrs [Hash] A hash of attributes to assign to created user
+      # @example
+      #   client.create_user(:username => 'testuser', password: 'letmein', email: 'test@example.com', org_id: 3)
+      def create_user(attrs = {})
+        object_from_response(Code42::User, :post, "user", attrs)
+      end
+
+      # Returns information for a given user
+      # @return [Code42::User] The requested user
+      # @param id_or_username [String, Integer] A code42 user ID or username
+      def user(id_or_username = "my", params = {})
+        if id_or_username.is_a?(Fixnum) || id_or_username == 'my'
+          find_user_by_id id_or_username, params
+        else
+          find_user_by_username id_or_username, params
+        end
+      end
+
+      # Returns a user for a given id
+      def find_user_by_id(id = 'my', params = {})
+        object_from_response(Code42::User, :get, "user/#{id}", params)
+      end
+
+      # Returns a user for a given username
+      def find_user_by_username(username, params = {})
+        params.merge!(username: username)
+        users(params).first
+      end
+
+      # Returns a user for a given channel id
+      # @return [Code42::User] The requested user
+      # @param channel_id [String, Integer] A code42 User
+      def find_user_by_channel_id(channel_id = 1)
+        object_from_response(Code42::User, :get, "userChannel?channelCustomerId=#{channel_id}")
+      end
+
+      # Returns a list of up to 100 users
+      # @return [Array] An array of matching users
+      # @param params [Hash] A hash of parameters to match results against
+      def users(params = {})
+        params.merge!(key: 'users')
+        objects_from_response(Code42::User, :get, 'user', params)
+      end
+
+      # Check if user exists with given username.
+      def user_exists?(username)
+        users(username: username).present?
+      end
+
+      # Block a user from logging in
+      # @return true if blocked
+      # @params id [Integer, String] The user ID you want to block
+      def block_user(id)
+        put("UserBlock/#{id}")
+      end
+
+      # Unblock a previously blocked user
+      # @return true if unblocked
+      # @params id [Integer, String] The user ID you want to unblock
+      def unblock_user(id)
+        delete("UserBlock/#{id}")
+      end
+    end
+  end
+end