kazoo-ruby-sdk 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f20d971051c409aac8c71468c535b7a8956c8d1a
-  data.tar.gz: 883d34a81909372d993ada42152f01966b2d7ebe
+  metadata.gz: 18dd15e7663fd59b3e8b94c0ad156e1d0ba180a5
+  data.tar.gz: fb0b1cdbe45f825110df53d86781d34b44d27978
 SHA512:
-  metadata.gz: 698c4c9dcc7aef7ee2138a2e4090bae2f97c91868783c70587eb9d23b6777642296e87819340a31248eca4809a974975697251f395a3dd33982a276d0a3c7862
-  data.tar.gz: 849ee41c57da5da8c15e038c9a1f7b4aacd00caf4abe2e406523911e386e3de381a57d4a6324f3ac54c75295d396b9cbacc413a5d0738a0219a109736533b504
+  metadata.gz: 4afe2bec7fc29eabeea036dc3ba0a471acdc60fc6b907da3bb27b015b626045c84331d86d510761ba1ffc9d77db863fcd28a64fcd779e994b11c556072e114dc
+  data.tar.gz: 125715ff7f377cc991107d46d35b62cd6ac46c7def93d0fcc927d3b21e1c9cb6aa74abe7d1b1cb31c9856a516e1b8d899d64472586d67440b49f8e21de7f4f59

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -7,4 +7,8 @@ gem 'faraday'
 gem 'faraday_middleware'
 gem 'multi_json'
 gem 'hashie'
-gem 'yajl-ruby'
+gem 'yajl-ruby'
+
+group :development, :test do
+  gem 'rspec-rails'
+end

data/README.md

@@ -22,27 +22,37 @@ Or install it yourself as:
 
 Create config/initializers/kazoo_ruby_sdk.rb
 ```ruby
-KazooRubySdk.auth_url = 'http://yourserver.com:8000/v1'
-KazooRubySdk.realm = 'your-realm'
-KazooRubySdk.username = 'your-username'
-KazooRubySdk.password = 'your-password'
+KazooRubySdk.configure do |config|
+  config.auth_url = 'http://yourserver.com:8000/v1'
+  config.realm = 'your-realm'
+  config.username = 'your-username'
+  config.password = 'your-password'
+end
 ```
 
 ## Usage
 ```ruby
-api = KazooRubySdk::AuthSession.new    
-session = api.new_session    
-devices = session.list_devices.data    
+devices = KazooRubySdk::Devices.list.data        
 device_id = devices[0].id    
-device = session.get_device(device_id)
+device = KazooRubySdk::Devices.get(device_id)
 ```
  
 ## List of methods
 
-* list_devices()
-* get_device(device_id)
-* get_device_statuses
-* create_device(name)
+#### Devices
+* list()
+* get(device_id)
+* get_statuses
+* create(attributes)
+* update(id, attributes)
+* destroy(id)
+
+#### Users
+* list()
+* get(id)
+* create(attributes)
+* update(id, attributes)
+* destroy(id)
 
 ## Contributing
 

data/kazoo-ruby-sdk.gemspec

@@ -32,4 +32,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency 'faraday', '~> 0.12'
+  spec.add_dependency 'faraday_middleware', '~> 0.11'
+  spec.add_dependency 'multi_json', '~> 1.12'
+  spec.add_dependency 'hashie', '~> 3.5'
+  spec.add_dependency 'yajl-ruby', '~> 1.3'
 end

data/lib/kazoo-ruby-sdk.rb

@@ -3,12 +3,31 @@ require 'faraday'
 require 'faraday_middleware'
 require 'digest/md5'
 
+require 'kazoo-ruby-sdk/configuration'
+require 'kazoo-ruby-sdk/session'
 require 'kazoo-ruby-sdk/base'
-require 'kazoo-ruby-sdk/auth_session'
-require 'kazoo-ruby-sdk/api_session'
+require 'kazoo-ruby-sdk/devices'
+require 'kazoo-ruby-sdk/users'
 
 module KazooRubySdk
   class << self
-    attr_accessor :auth_url, :realm, :username, :password
+    attr_accessor :configuration, :cache
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.cache
+    @cache
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    self.cache = ActiveSupport::Cache::MemoryStore.new
+    yield(configuration)
   end
 end

data/lib/kazoo-ruby-sdk/base.rb

@@ -1,15 +1,33 @@
 module KazooRubySdk
   class Base
-    def create_conn_object(url)
-      Faraday.new(:url => url,
-                  :user_agent => 'Kazoo Ruby SDK') do |builder|
-        builder.use Faraday::Response::Mashify
-        builder.use Faraday::Response::ParseJson
-        builder.use Faraday::Response::RaiseError
-        builder.use Faraday::Request::JSON
-        builder.use Faraday::Request::UrlEncoded
-        builder.adapter Faraday.default_adapter
-      end
+    class << self
+      attr_accessor :auth_token, :api_url, :realm, :account_id, :owner_id, :pipe
+    end
+
+    private
+
+    def self.auth_token
+      KazooRubySdk::Session.auth_token
+    end
+
+    def self.api_url
+      KazooRubySdk::Session.api_url
+    end
+
+    def self.realm
+      KazooRubySdk::Session.realm
+    end
+
+    def self.account_id
+      KazooRubySdk::Session.account_id
+    end
+
+    def self.owner_id
+      KazooRubySdk::Session.owner_id
+    end
+
+    def self.pipe
+      KazooRubySdk::Session.pipe
     end
   end
 end

data/lib/kazoo-ruby-sdk/configuration.rb

@@ -0,0 +1,5 @@
+module KazooRubySdk
+  class Configuration
+    attr_accessor :api_url, :realm, :username, :password
+  end
+end

data/lib/kazoo-ruby-sdk/devices.rb

@@ -0,0 +1,49 @@
+module KazooRubySdk
+  class Devices < Base
+    class << self
+      def list
+        pipe.get do |request|
+          request.url "accounts/#{account_id}/devices"
+          request.headers['X-Auth-Token'] = auth_token
+        end.body
+      end
+
+      def get(device_id)
+        pipe.get do |request|
+          request.url "accounts/#{account_id}/devices/#{device_id}"
+          request.headers['X-Auth-Token'] = auth_token
+        end.body
+      end
+
+      def get_statuses
+        pipe.get do |request|
+          request.url "accounts/#{account_id}/devices/status"
+          request.headers['X-Auth-Token'] = auth_token
+        end.body
+      end
+
+      def create(attributes)
+        pipe.put do |request|
+          request.url "accounts/#{account_id}/devices"
+          request.headers['X-Auth-Token'] = auth_token
+          request.body = { data: attributes }
+        end.body
+      end
+
+      def update(device_id, attributes)
+        pipe.patch do |request|
+          request.url "accounts/#{account_id}/devices/#{device_id}"
+          request.headers['X-Auth-Token'] = auth_token
+          request.body = { data: attributes }
+        end.body
+      end
+
+      def destroy(device_id)
+        pipe.delete do |request|
+          request.url "accounts/#{account_id}/devices/#{device_id}"
+          request.headers['X-Auth-Token'] = auth_token
+        end.body
+      end
+    end
+  end
+end

data/lib/kazoo-ruby-sdk/session.rb

@@ -0,0 +1,56 @@
+module KazooRubySdk
+  class Session
+    class << self
+      attr_writer :api_url, :realm, :account_id, :owner_id, :auth_token, :pipe
+    end
+
+    class << self
+      def api_url
+        KazooRubySdk.configuration.api_url
+      end
+
+      def realm
+        KazooRubySdk.configuration.realm
+      end
+
+      def account_id
+        auth_response.data.account_id
+      end
+
+      def owner_id
+        auth_response.data.owner_id
+      end
+
+      def auth_token
+        auth_response.auth_token
+      end
+
+      def pipe
+        create_conn_object(api_url)
+      end
+
+      def create_conn_object(url)
+        Faraday.new(:url => url, ssl: { verify: false }) do |builder|
+          builder.use Faraday::Response::Mashify
+          builder.use Faraday::Response::ParseJson
+          builder.use Faraday::Response::RaiseError
+          builder.use FaradayMiddleware::EncodeJson
+          builder.use Faraday::Request::UrlEncoded
+          builder.adapter Faraday.default_adapter
+        end
+      end
+
+      def auth_response
+        KazooRubySdk.cache.fetch('auth_response') do
+          req = {:data => {:credentials => get_credentials_hash, :realm => self.realm}, :verb => 'PUT'}
+          response = pipe.put 'user_auth', req
+          response.body
+        end
+      end
+
+      def get_credentials_hash
+        Digest::MD5.hexdigest("#{KazooRubySdk.configuration.username}:#{KazooRubySdk.configuration.password}")
+      end
+    end
+  end
+end

data/lib/kazoo-ruby-sdk/users.rb

@@ -0,0 +1,42 @@
+module KazooRubySdk
+  class Users < Base
+    class << self
+      def create(attributes)
+        pipe.put do |request|
+          request.url "accounts/#{account_id}/users"
+          request.headers['X-Auth-Token'] = auth_token
+          request.body = { data: attributes }
+        end.body
+      end
+
+      def update(user_id, attributes)
+        pipe.patch do |request|
+          request.url "accounts/#{account_id}/users/#{user_id}"
+          request.headers['X-Auth-Token'] = auth_token
+          request.body = { data: attributes }
+        end.body
+      end
+
+      def list
+        pipe.get do |request|
+          request.url "accounts/#{account_id}/users"
+          request.headers['X-Auth-Token'] = auth_token
+        end.body
+      end
+
+      def get(user_id)
+        pipe.get do |request|
+          request.url "accounts/#{account_id}/users/#{user_id}"
+          request.headers['X-Auth-Token'] = auth_token
+        end.body
+      end
+
+      def destroy(user_id)
+        pipe.delete do |request|
+          request.url "accounts/#{account_id}/users/#{user_id}"
+          request.headers['X-Auth-Token'] = auth_token
+        end.body
+      end
+    end
+  end
+end

data/lib/kazoo-ruby-sdk/version.rb

@@ -1,3 +1,3 @@
 module KazooRubySdk
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kazoo-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Aleksey Pohodnya
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-05 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: You can specify the data to access your Kazoo server and use the Kazoo
   API using the methods of this sdk.
 email:
@@ -47,15 +117,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - kazoo-ruby-sdk.gemspec
 - lib/kazoo-ruby-sdk.rb
-- lib/kazoo-ruby-sdk/api_session.rb
-- lib/kazoo-ruby-sdk/auth_session.rb
 - lib/kazoo-ruby-sdk/base.rb
+- lib/kazoo-ruby-sdk/configuration.rb
+- lib/kazoo-ruby-sdk/devices.rb
+- lib/kazoo-ruby-sdk/session.rb
+- lib/kazoo-ruby-sdk/users.rb
 - lib/kazoo-ruby-sdk/version.rb
 homepage: https://github.com/pohodnya/kazoo-ruby-sdk
 licenses:

data/lib/kazoo-ruby-sdk/api_session.rb

@@ -1,35 +0,0 @@
-module KazooRubySdk
-  class ApiSession < Base
-    attr_reader :auth_token, :api_url, :realm, :account_id, :owner_id, :pipe
-
-    def initialize(options)
-      @auth_token = options[:auth_token]
-      @api_url = options[:api_url]
-      @realm = options[:realm]
-      @account_id = options[:account_id]
-      @owner_id = options[:owner_id]
-      @pipe = create_conn_object(api_url)
-    end
-
-    def list_devices()
-      return pipe.get("accounts/#{account_id}/devices",
-                      'X-Auth-Token' => auth_token).body
-    end
-
-    def get_device(device_id)
-      return pipe.get("accounts/#{account_id}/devices/#{device_id}",
-                      'X-Auth-Token' => auth_token).body
-    end
-
-    def get_device_statuses
-      return pipe.get("accounts/#{account_id}/devices/status",
-                      'X-Auth-Token' => auth_token).body
-    end
-
-    def create_device(name)
-      return pipe.put("accounts/#{account_id}/devices",
-                      {:data => {:name => name}},
-                      'X-Auth-Token' => auth_token).body
-    end
-  end
-end

data/lib/kazoo-ruby-sdk/auth_session.rb

@@ -1,57 +0,0 @@
-module KazooRubySdk
-  class AuthSession < Base
-    attr_accessor :auth_url, :realm, :username, :password
-    attr_reader :auth_pipe, :auth_token, :account_id, :owner_id, :api_url, :api_pipe, :api_token
-
-    def initialize
-      @auth_url = KazooRubySdk.auth_url
-      @realm = KazooRubySdk.realm
-      @username = KazooRubySdk.username
-      @password = KazooRubySdk.password
-
-      @auth_pipe = create_conn_object(auth_url)
-    end
-
-    def is_authenticated?
-      return !auth_token.nil?
-    end
-
-    def new_session
-      authenticate! unless is_authenticated?
-      return ApiSession.new(:auth_token => api_token, :api_url => api_url, :realm => realm, :account_id => account_id, :owner_id => owner_id)
-    end
-
-    def get_credentials_hash
-      return Digest::MD5.hexdigest("#{username}:#{password}")
-    end
-
-    def authenticate!
-      req = {:data => {:credentials => get_credentials_hash, :realm => realm}, :verb => 'PUT'}
-      response = auth_pipe.put 'user_auth', req
-      @auth_token = response.body.auth_token
-      @account_id = response.body.data.account_id
-      @owner_id = response.body.data.owner_id
-
-      @api_url = select_session_endpoint_app('voip')
-      @api_pipe = create_conn_object(api_url)
-      shared_auth
-    end
-
-    def shared_auth
-      req = {:data => {:realm => realm, :account_id => account_id, :shared_token => auth_token}, :verb => 'PUT'}
-      resp = @api_pipe.put 'shared_auth', req
-      @api_token = resp.body.auth_token
-      return api_token
-    end
-
-    def get_endpoint_apps
-      auth_pipe.get "accounts/#{account_id}/users/#{owner_id}", 'X-Auth-Token' => auth_token
-    end
-
-    def select_session_endpoint_app(name)
-      apps = get_endpoint_apps
-      @api_url = apps.body.data.apps[name].api_url
-      return api_url
-    end
-  end
-end