panasonic_rcs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 100077aae71b80b7c86682bc567c1c152422290a
+  data.tar.gz: 6e843040eb4d758f3cd6b30b4b9b7a6d86603d20
+SHA512:
+  metadata.gz: 6a1feb99abe733c262261776296396921b456a4413205fabb05e8ac2238a2eb44234bbbce195ccbdb837ad1a789f4a0cc16168cdf421beef74d262e0abf75bc1
+  data.tar.gz: 6fe1aa17279a43c4c768c9120fc9f897b961b988a2a3b1db6d8844dcb650039ca2c7830c6834805ab6b76e9511af89fda7f0c4c73b21a7d683bd1b74b2c95d92

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in panasonic_rcs.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'rspec', cmd: 'rspec' do
+  watch(%r{^(lib/.+)\.rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  watch(%r{^spec/(.+)\.rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Emery A. Miller
+
+MIT License
+
+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,56 @@
+# PanasonicRcs
+
+This gem wraps the panasonic XMLRPC RCS service. Basically can be used
+to register a mac address with their service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'panasonic_rcs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install panasonic_rcs
+
+## Usage
+
+```ruby
+# Create a connection, and pass it to the RCS service object
+rcs= PanasonicRcs::Rcs.new(PanasonicRcs::Connection.new(username: 'username', password: 'password'))
+
+# List all registered phones on this account
+rcs.list_phones
+# => ["0030A0360ABF", "0030E01604E2"]
+
+rcs.phone('0040F0CC8E43')
+
+# => {"mac"=>"0040F0CC8E43",
+      "url"=>"http://server/model/model.cfg",
+      "register_date"=>#<DateTime: 2015-10-26T11:58:31+00:00 ((2457322j,43111s,0n),+0s,2299161j)>,
+      "access_date"=>#<DateTime: 2015-10-30T13:14:01+00:00 ((2457326j,47641s,0n),+0s,2299161j)>,
+      "note"=>"some note",
+      "profile"=>"kxutg200bv3",
+      "model"=>"KX-UTG200B",
+      "version"=>nil}
+
+rcs.register_phone_with_profile('0040F0CC8E43', 'tgp500')
+
+# => true
+```
+
+Errors will raise an RcsError exception.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/panasonic_rcs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'progress']
+end
+
+task default: :spec

data/lib/panasonic_rcs.rb

@@ -0,0 +1,8 @@
+require "panasonic_rcs/version"
+require "panasonic_rcs/connection"
+require "panasonic_rcs/rcs_error"
+require "panasonic_rcs/rcs"
+
+module PanasonicRcs
+  # Your code goes here...
+end

data/lib/panasonic_rcs/connection.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'multi_xml'
+module PanasonicRcs
+  class Connection
+    attr_reader :host
+    attr_accessor :log
+
+    def initialize(username: '', password: '', log: nil, adapter: [:net_http])
+      @conn = Faraday.new(url: "https://provisioning.e-connecting.net/") do |builder|
+        builder.use Faraday::Request::BasicAuthentication, username, password
+        builder.use FaradayMiddleware::ParseXml, content_type: /\bxml$/
+        builder.use Faraday::Response::Logger, log if log
+        builder.adapter *adapter
+      end
+    end
+
+    def post(body)
+      @conn.post do |req|
+        req.url '/redirect/xmlrpc'
+        req.headers['Content-Type'] = 'text/xml'
+        req.body = body
+      end
+    end
+  end
+end

data/lib/panasonic_rcs/rcs.rb

@@ -0,0 +1,62 @@
+module PanasonicRcs
+  class Rcs
+    attr_reader :connection, :response
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def list_phones
+      request = "<?xml version=\"1.0\"?><methodCall><methodName>ipredirect.listPhones</methodName></methodCall>"
+      @response = connection.post(request)
+      fail RcsError.new "System responded with a #{@response.status} status." if @response.status != 200
+
+      body = @response.body['methodResponse']
+      if fault = body['fault']
+        fault_string = fault['value']['struct']['member'][1]['value']['string']
+        fail RcsError.new fault_string
+      end
+      body['params']['param']['value']['array']['data']['value'].map {|k| k["string"]}
+    end
+
+    def phone(raw_mac_addr)
+      mac_addr = raw_mac_addr.gsub(/[^[:alnum:]]/, '')
+      body = "<?xml version=\"1.0\"?><methodCall><methodName>ipredirect.getPhone</methodName><params><param><value><string>#{mac_addr}</string></value></param></params></methodCall>"
+      @response = connection.post(body)
+      fail RcsError.new "System responded with a #{@response.status} status." if @response.status != 200
+
+      body = @response.body['methodResponse']
+      if fault = body['fault']
+        fault_string = fault['value']['struct']['member'][1]['value']['string']
+        fail RcsError.new fault_string
+      end
+      parse_struct(body['params']['param']['value']['struct']['member'])
+    end
+
+    def register_phone_with_profile(raw_mac_addr, profile)
+      mac_addr = raw_mac_addr.gsub(/[^[:alnum:]]/, '')
+      body = "<?xml version=\"1.0\"?><methodCall><methodName>ipredirect.registerPhoneWithProfile</methodName><params><param><value><string>#{mac_addr}</string></value></param><param><value><string>#{profile}</string></value></param></params></methodCall>"
+      @response = connection.post(body)
+      fail RcsError.new "System responded with a #{@response.status} status." if @response.status != 200
+
+      body = @response.body['methodResponse']
+      if fault = body['fault']
+        fault_string = fault['value']['struct']['member'][1]['value']['string']
+        fail RcsError.new fault_string
+      end
+      body['params']['param']['value']['boolean'] == "1"
+    end
+
+
+    private
+
+    def parse_struct(struct)
+      struct.each_with_object({}) {|member, obj| obj[member['name']] = parse_value(member['value'].keys.first, member['value'].values.first)}
+    end
+
+    def parse_value(value_type, value)
+      type_conversion = {'string' => ->(x){x}, 'dateTime.iso8601' => ->(x) {DateTime.iso8601(x)}}
+      translator = type_conversion.fetch(value_type) { ->(x) {x} }
+      translator.call(value)
+    end
+  end
+end

data/lib/panasonic_rcs/rcs_error.rb

@@ -0,0 +1 @@
+class RcsError < StandardError; end

data/lib/panasonic_rcs/version.rb

@@ -0,0 +1,3 @@
+module PanasonicRcs
+  VERSION = "0.0.1"
+end

data/panasonic_rcs.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'panasonic_rcs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "panasonic_rcs"
+  spec.version       = PanasonicRcs::VERSION
+  spec.authors       = ["Emery A. Miller"]
+  spec.email         = ["emiller@jive.com"]
+  spec.summary       = %q{A component to make XMLRPC calls to Panasonic's RCS service}
+  spec.description   = %q{A ruby wrapper around Panasonic's XMLRPC RCS service}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+
+  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "faraday_middleware"
+  spec.add_runtime_dependency "multi_xml"
+end

data/spec/lib/panasonic_rcs/connection_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe PanasonicRcs::Connection do
+  let(:test_adapter) {
+    Faraday::Adapter::Test::Stubs.new do |stub|
+      stub.post('/redirect/xmlrpc') { |env| [200, {'Content-Type' => 'application/xml'}, '<?xml version="1.0" encoding="UTF-8"?><reply>Good</reply>'] }
+    end
+  }
+
+  subject {PanasonicRcs::Connection.new(adapter: [:test, test_adapter])}
+  it 'sends a post request to the rcs xmlrpc service' do
+    result = {'reply' => 'Good'}
+    expect(subject.post('<?xml version="1.0" encoding="UTF-8"?><stuff></stuff>').body).to eq result
+    test_adapter.verify_stubbed_calls
+  end
+end

data/spec/lib/panasonic_rcs/rcs_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe PanasonicRcs::Rcs do
+  # These responses were taken from the Panasonic RCS documentation (https://fw-provi.e-connecting.net/manual/class1/RedirectServerXML-RPC_ExternalSpec_for_class_1_user_1.6.pdf)
+  let(:list_success) {'<?xml version="1.0" encoding="UTF-8"?><methodResponse><params><param><value><array><data><value><string>08F0C0123456</string></value> <value><string>08F0C0123456</string></value></data></array></value></param></params></methodResponse>'}
+  let(:list_error)   {'<?xml version="1.0" encoding="UTF-8"?><methodResponse> <fault> <value><struct> <member> <name>faultCode</name> <value><int>1</int></value> </member> <member> <name>faultString</name> <value><string>Invalid XML format</string></value> </member> </struct></value> </fault> </methodResponse>'}
+  let(:register_success){'<?xml version="1.0" encoding="UTF-8"?> <methodResponse> <params> <param> <value><boolean>1</boolean></value> </param> </params> </methodResponse>'}
+  let(:register_error){'<?xml version="1.0" encoding="UTF-8"?> <methodResponse> <fault> <value><struct> <member> <name>faultCode</name> <value><int>201</int></value> </member> <member> <name>faultString</name> <value><string>08F0C0123456:Invalid MAC address</string></value> </member> </struct></value> </fault> </methodResponse>'}
+  let(:getphone_success) {'<?xml version="1.0" encoding="UTF-8"?> <methodResponse><params> <param> <value> <struct> <member> <name>mac</name> <value><string>08F0C0123456</string></value> </member> <member> <name>url</name> <value><string>http://xxx/xxxxxx/xxx?xxx={MAC}</string></value> </member> <member> <name>register_date</name> <value><dateTime.iso8601>2011-07-12T05:32:12Z</dateTime.iso8601></value> </member> <member> <name>access_date</name> <value><dateTime.iso8601>2011-07-12T06:08:35Z</dateTime.iso8601></value> </member> <member> <name>note</name> <value><string>For test</string></value> </member> <member> <name>model</name> <value><string>KX-TGP550T01</string></value> </member> <member> <name>version</name> <value><string>1.00</string></value> </member> <member> <name>profile</name> <value><string> for KX-TGP500</string></value> </member> </struct> </value></param></params></methodResponse>'}
+  let(:getphone_error) {'<?xml version="1.0" encoding="UTF-8"?> <methodResponse> <fault> <value><struct> <member> <name>faultCode</name> <value><int>203</int></value> </member> <member> <name>faultString</name> <value><string>08F0C0123456: You are not owner of the phone.</string></value> </member> </struct></value></fault></methodResponse>'}
+
+  let(:test_adapter) { Faraday::Adapter::Test::Stubs.new }
+  let(:connection) {PanasonicRcs::Connection.new(adapter: [:test, test_adapter])}
+  let(:subject) {PanasonicRcs::Rcs.new(connection)}
+
+  it 'sends a list phones request and parses the response' do
+    test_adapter.post('/redirect/xmlrpc') {[200, {'Content-Type' => 'application/xml'}, list_success]}
+    expect(subject.list_phones).to eq ['08F0C0123456','08F0C0123456']
+  end
+
+  it 'raises an error if one is returned' do
+    test_adapter.post('/redirect/xmlrpc') {[200, {'Content-Type' => 'application/xml'}, list_error]}
+    expect {subject.list_phones}.to raise_error RcsError, 'Invalid XML format'
+  end
+
+  it 'raises an error if the status code is not 200' do
+    test_adapter.post('/redirect/xmlrpc') {[403, {'Content-Type' => 'application/xml'}, '']}
+    expect {subject.list_phones}.to raise_error RcsError, /403/
+  end
+
+  it 'registers a phone successfully' do
+    test_adapter.post('/redirect/xmlrpc') {[200, {'Content-Type' => 'application/xml'}, register_success]}
+    expect(subject.register_phone_with_profile('123456789123', 'kutg200b')).to eq true
+  end
+
+  it 'fails to register a phone and reports the error' do
+    test_adapter.post('/redirect/xmlrpc') {[200, {'Content-Type' => 'application/xml'}, register_error]}
+    expect{subject.register_phone_with_profile('123456789123', 'kutg200b')}.to raise_error RcsError, /Invalid MAC address/
+  end
+
+  it 'checks on a phone already in our system' do
+    test_adapter.post('/redirect/xmlrpc') {[200, {'Content-Type' => 'application/xml'}, getphone_success]}
+    expect(subject.phone('123456789123')).to eq( {"mac"=>"08F0C0123456", "url"=>"http://xxx/xxxxxx/xxx?xxx={MAC}", "register_date"=> DateTime.iso8601('2011-07-12T05:32:12Z'), "access_date"=> DateTime.iso8601('2011-07-12T06:08:35Z'), "note"=>"For test", "model"=>"KX-TGP550T01", "version"=>"1.00", "profile"=>" for KX-TGP500"})
+  end
+
+  it 'checks on a phone not in our system yet' do
+    test_adapter.post('/redirect/xmlrpc') {[200, {'Content-Type' => 'application/xml'}, getphone_error]}
+    expect{subject.phone('123456789123')}.to raise_error RcsError, /You are not owner/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'pry'
+require 'panasonic_rcs'

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: panasonic_rcs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Emery A. Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby wrapper around Panasonic's XMLRPC RCS service
+email:
+- emiller@jive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/panasonic_rcs.rb
+- lib/panasonic_rcs/connection.rb
+- lib/panasonic_rcs/rcs.rb
+- lib/panasonic_rcs/rcs_error.rb
+- lib/panasonic_rcs/version.rb
+- panasonic_rcs.gemspec
+- spec/lib/panasonic_rcs/connection_spec.rb
+- spec/lib/panasonic_rcs/rcs_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A component to make XMLRPC calls to Panasonic's RCS service
+test_files:
+- spec/lib/panasonic_rcs/connection_spec.rb
+- spec/lib/panasonic_rcs/rcs_spec.rb
+- spec/spec_helper.rb