kazoo-ruby-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecbde70ef3fe8ddaa2b4da5c1f17476ff9586145
+  data.tar.gz: 43cba6044df426331decec266ea01666ac0cc911
+SHA512:
+  metadata.gz: ade7b3e505d08fa96c7a3370a1e3b4983722cde58965684805b9287e0f6c6527348b02e9eb9928c4abd596f4433850bd11dd8a3ac9869368a54288da07628e33
+  data.tar.gz: 632ac22eb62212e9f4c29c308e2e3ecc43635f87bec68883befc01b8bbb680833a09995fa3fe9a32734ccb477f875fba11b3b126d52bd5cecfea10c00f248175

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.idea
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kazoo-ruby-sdk.gemspec
+gemspec
+
+gem 'faraday'
+gem 'faraday_middleware'
+gem 'multi_json'
+gem 'hashie'
+gem 'yajl-ruby'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aleksey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Kazoo::Ruby::Sdk
+
+SDK for Kazoo API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kazoo-ruby-sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kazoo-ruby-sdk
+
+## Config
+
+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'
+```
+
+## Usage
+```ruby
+api = Whistle::Sdk::AuthSession.new    
+session = api.new_session    
+devices = session.list_devices.data    
+device_id = devices[0].id    
+device = session.get_device(device_id)
+```
+ 
+## List of methods
+
+* list_devices()
+* get_device(device_id)
+* get_device_statuses
+* create_device(name)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pohodnya/kazoo-ruby-sdk.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/kazoo-ruby-sdk.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kazoo-ruby-sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kazoo-ruby-sdk"
+  spec.version       = KazooRubySdk::VERSION
+  spec.authors       = ["Aleksey Pohodnya"]
+  spec.email         = ["pohodnyaa@gmail.com"]
+
+  spec.summary       = 'SDK for Kazoo API'
+  spec.description   = 'You can specify the data to access your Kazoo server and use the Kazoo API using the methods of this sdk.'
+  spec.homepage      = "https://github.com/pohodnya/kazoo-ruby-sdk"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/kazoo-ruby-sdk.rb

@@ -0,0 +1,14 @@
+require 'kazoo-ruby-sdk/version'
+require 'faraday'
+require 'faraday_middleware'
+require 'digest/md5'
+
+require 'kazoo-ruby-sdk/base'
+require 'kazoo-ruby-sdk/auth_session'
+require 'kazoo-ruby-sdk/api_session'
+
+module KazooRubySDK
+  class<< self
+    attr_accessor :auth_url, :realm, :username, :password
+  end
+end

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

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,57 @@
+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

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

@@ -0,0 +1,15 @@
+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
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module KazooRubySdk
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: kazoo-ruby-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksey Pohodnya
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: You can specify the data to access your Kazoo server and use the Kazoo
+  API using the methods of this sdk.
+email:
+- pohodnyaa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- 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/version.rb
+homepage: https://github.com/pohodnya/kazoo-ruby-sdk
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: SDK for Kazoo API
+test_files: []