caplinked-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a246e596746f56c885e545285546dafc71bc019
-  data.tar.gz: c6e3ef73bd02fb2a64286e496e8d5c550f8c9366
+  metadata.gz: c0d4531955ecae124eecdd22fa0f9fd60c7e4725
+  data.tar.gz: 29e7dfccd6fdd947a5834e344d00a6060e00c535
 SHA512:
-  metadata.gz: b5166ac3453bcc6126ffb6b5aac5ca2f94889522db7f51fd55777f4246fc06367835b2923ca6668113619a38e65f9e560d7ea86a1df4114a99bee1314d66f28d
-  data.tar.gz: 961c9a18d1ffb959fd850eda834af29d242b2ce060fc8083eaa8318966bd3522f5b1400b6a82d6c5d924489d406c1f7a426fec89f7f14ba50bb68922cee070dc
+  metadata.gz: 51e08fdb619be01e391c385cb25618efd05eb403d29858c6548ef5763d311d550b715b24dce3ea16f74abe0e340a00cc0f3280c7b9f79b54d2ead54fdaa76082
+  data.tar.gz: 3f422623d166ad2036e3083b3bf9bb7b7f575f3c016155a30c17d6b95444114219bc09871cafe5f611b05feeba270708826002aec3c04aa179fe6512c0e688f9

data/README.md

@@ -3,6 +3,8 @@
 Ruby SDK for Caplinked's API
 Documentation at https://developer.caplinked.com/docs
 
+Changelog at https://developer.caplinked.com/api-changelog
+
 ## Quick start guide:
 
 Add Rubygem to Bundle:
@@ -14,7 +16,78 @@ gem 'caplinked-api'
 Assign Client
 
 ```
-client = Caplinked::Client.new api_key: 'YOUR_KEY_HERE', api_host: 'sandbox.caplinked.com', api_scheme: 'https'
+client = Caplinked::Client.new api_host: 'sandbox.caplinked.com', api_scheme: 'https'
+
+client.api_key = 'YOUR_PUBLIC_API_KEY'
+client.api_secret_key = 'YOUR_SECRET_API_KEY'
+client.api_user_token = 'USER_RESOURCE_IDENTIFIER_TOKEN'
+```
+
+Get User Info
+
+```
+# Info about the current user (in this case John Smith, an organization admin)
+
+client.get_user_info
+
+# response
+{
+  "id": 9818,
+  "first_name": "John",
+  "last_name": "Smith",
+  "email": "john@example.com",
+  "time_zone": "Pacific Time (US & Canada)",
+  "user_token": "fc39b9012e47a5713932094065e17fb7ab76e83d"
+}
+
+# As an organization admin, list all members of your organization
+
+client.show_organization_members
+
+# response
+{
+  "users": [
+    {
+      "id": 9818,
+      "first_name": "John",
+      "last_name": "Smith",
+      "email": "john@example.com",
+      "time_zone": "Pacific Time (US & Canada)",
+      "user_token": "fc39b9012e47a5713932094065e17fb7ab76e83d"
+      "organization_admin": true
+    },
+    {
+      "id": 9820,
+      "first_name": "Jina",
+      "last_name": "Baker",
+      "email": "jina@example.com",
+      "time_zone": "Pacific Time (US & Canada)",
+      "user_token": "e05b83c6714120fb87a176241bc2031f22f5cf4a",
+      "organization_admin": false
+    }
+  ]
+}
+```
+
+Make API calls for a different user resource
+
+```
+# Switch to Jina's user token
+
+client.api_user_token = 'e05b83c6714120fb87a176241bc2031f22f5cf4a'
+
+client.get_user_info 
+
+# response
+{
+  "id": 9820,
+  "first_name": "Jina",
+  "last_name": "Baker",
+  "email": "jina@example.com",
+  "time_zone": "Pacific Time (US & Canada)",
+  "user_token": "e05b83c6714120fb87a176241bc2031f22f5cf4a"
+}
+
 ```
 ## Activities:
 
@@ -308,6 +381,12 @@ Update user
 update_user = client.update_user user: { email: 'new email address'}
 ```
 
+Delete user
+
+```
+result = client.delete_user user: { id: 32523 }
+```
+
 ##Workspace
 List all workspaces for a team
 

data/lib/caplinked/client.rb

@@ -9,12 +9,15 @@ module Caplinked
   class Client
     include Caplinked::Utils
     include Caplinked::REST::API
-    attr_accessor :api_key, :api_host, :api_scheme
+    attr_accessor :api_key, :api_secret_key, :api_user_token, :api_host, :api_scheme
 
     # Usage:
     # client = Caplinked::Client.new api_key: '...', api_host: 'sandbox.caplinked.com'
-    # client.upload_file file_name: '...', 
+    # client.upload_file file_name: '...',
     def initialize(options = {})
+      options[:api_key] ||= ''
+      options[:api_secret_key] ||= ''
+      options[:api_user_token] ||= ''
       options[:api_host] ||= 'sandbox.caplinked.com'
       options[:api_scheme] ||= 'https'
 

data/lib/caplinked/request.rb

@@ -16,15 +16,27 @@ module Caplinked
     end
 
     def perform
-      headers = (@options.delete(:headers) || {}).merge('X-Token' => @client.api_key)
       @uri.query_values = @options.delete(:params)
-      response = HTTP.headers(headers).request(@request_method, @uri.to_s, @options)
+      response = HTTP.headers(req_headers).request(@request_method, @uri.to_s, @options)
       response_body = response.body.empty? ? '' : change_keys_to_symbols(response.parse)
       response_headers = response.headers
       fail_or_return_response_body(response.code, response_body, response_headers)
     end
 
   private
+
+    def req_headers
+      expiration = 5.minutes.from_now.utc.to_s
+      signature = "Method=HMAC-SHA256 Signature=" + OpenSSL::HMAC.hexdigest('SHA256', @client.api_secret_key, [@client.api_key.to_s, @client.api_user_token.to_s,expiration].join)
+      default_headers = {
+        'x-api-key' => @client.api_key,
+        'x-api-user-token' => @client.api_user_token,
+        'x-api-exp-date' => expiration,
+        'x-api-signature' => signature
+      }
+      (@options.delete(:headers) || {}).merge(default_headers)
+    end
+
     def change_keys_to_symbols(parsed_response)
       if parsed_response.is_a?(Hash)
         parsed_response.deep_symbolize_keys

data/lib/caplinked/rest/users.rb

@@ -16,6 +16,11 @@ module Caplinked
         perform_put('/api/v1/users/me', nil, body.to_json, {'Content-Type' => 'application/json'} )
       end
 
+      def delete_user(options = {})
+        body = options.stringify_keys.slice('user')
+        perform_delete('/api/v1/users', nil, body.to_json, {'Content-Type' => 'application/json'})
+      end
+
     end
   end
 end

data/lib/caplinked/utils.rb

@@ -8,8 +8,8 @@ module Caplinked
       perform_request(:get, path, { params: params })
     end
 
-    def perform_delete(path, params = {})
-      perform_request(:delete, path, { params: params })
+    def perform_delete(path, params = {}, body = {}, headers = {})
+      perform_request(:delete, path, { params: params, body: body, headers: headers })
     end
 
     def perform_put(path, params = {}, body = {}, headers = {})

data/lib/caplinked/version.rb

@@ -9,7 +9,7 @@ module Caplinked
 
     # @return [Integer]
     def minor
-      2
+      3
     end
 
     # @return [Integer]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caplinked-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jordan Fowler
@@ -9,76 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-24 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: http-form_data
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Ruby SDK for Caplinked's API.
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - caplinked-api.gemspec
+- lib/caplinked-api.rb
 - lib/caplinked/client.rb
 - lib/caplinked/error.rb
 - lib/caplinked/request.rb
@@ -106,7 +107,6 @@ files:
 - lib/caplinked/rest/workspaces.rb
 - lib/caplinked/utils.rb
 - lib/caplinked/version.rb
-- lib/caplinked-api.rb
 homepage: https://github.com/caplinked/caplinked-api-ruby
 licenses:
 - MIT
@@ -117,17 +117,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Caplinked's API.