mitel_oig 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e835bc59d08f79c3ab98b9eeec4e3a55e5bbdef
-  data.tar.gz: c47ebd38f7ac04ef07f2ae904772f086b98629ed
+  metadata.gz: 369937cb7430072a4ed6d04a5d3feaa0122b15ef
+  data.tar.gz: c55d636471d2a9cce0b88b48cbe78e06fa3da2ce
 SHA512:
-  metadata.gz: 85fca323b6d56a645630b080cd6ecdf200b24294f0048efab66c670d12897e5d4b981d3e313f8d50bc2fd90f382ae431d11a528e906f446d36e76c3843314d11
-  data.tar.gz: 8a8dae7dcac9c2a415c67cea7833aecb88ec70a3990ca77647afd19345db0781e902315b235e2df16010cbfc6ab249664296415217772a6bd18ffee00491fa2d
+  metadata.gz: b13c9b64bf9dcb333496cdbe44268f7690250967bb99a36c238b5066c11662f5e411b2b527e0b254e26cc26a809a9689d3641f0ff530c25bcd2f943355b5c877
+  data.tar.gz: cb39f92ef2f141a57a666c7e58c4dd38642252ded59d13e78df00cb13c9e1965bfe3daf5704bc7189877e77818d0946d4dc5aeb41138b840fc1f433d770801b0

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,65 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - 2.1.3
+  - 2.1.4
+  - jruby
+jdk:
+  - openjdk6
+  - openjdk7
+  - oraclejdk7
+  - oraclejdk8
+branches:
+  only:
+    - master
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      jdk: openjdk6
+    - rvm: 1.9.3
+      jdk: oraclejdk7
+    - rvm: 1.9.3
+      jdk: oraclejdk8
+    - rvm: 2.0.0
+      jdk: openjdk6
+    - rvm: 2.0.0
+      jdk: oraclejdk7
+    - rvm: 2.0.0
+      jdk: oraclejdk8
+    - rvm: 2.1.0
+      jdk: openjdk6
+    - rvm: 2.1.0
+      jdk: oraclejdk7
+    - rvm: 2.1.0
+      jdk: oraclejdk8
+    - rvm: 2.1.1
+      jdk: openjdk6
+    - rvm: 2.1.1
+      jdk: oraclejdk7
+    - rvm: 2.1.1
+      jdk: oraclejdk8
+    - rvm: 2.1.2
+      jdk: openjdk6
+    - rvm: 2.1.2
+      jdk: oraclejdk7
+    - rvm: 2.1.2
+      jdk: oraclejdk8
+    - rvm: 2.1.3
+      jdk: openjdk6
+    - rvm: 2.1.3
+      jdk: oraclejdk7
+    - rvm: 2.1.3
+      jdk: oraclejdk8
+    - rvm: 2.1.4
+      jdk: openjdk6
+    - rvm: 2.1.4
+      jdk: oraclejdk7
+    - rvm: 2.1.4
+      jdk: oraclejdk8
+addons:
+  code_climate:
+    repo_token: 87dd0b9f07405e5835164de6f246b33f1baf908e72b4c493db23cd71da7da60f

data/README.md

@@ -1,5 +1,9 @@
 # Mitel::OIG
 
+[![Code Climate](https://codeclimate.com/github/plainprogrammer/mitel_oig/badges/gpa.svg)](https://codeclimate.com/github/plainprogrammer/mitel_oig)
+[![Test Coverage](https://codeclimate.com/github/plainprogrammer/mitel_oig/badges/coverage.svg)](https://codeclimate.com/github/plainprogrammer/mitel_oig)
+[![Build Status](https://travis-ci.org/plainprogrammer/mitel_oig.svg)](https://travis-ci.org/plainprogrammer/mitel_oig)
+
 This gem provides a client library for working with the Open Integration Gateway
 provided by Mitel phone systems. The library makes use of both the SOAP and REST
 interfaces to try to expose as much of the available functionality as possible.
@@ -25,7 +29,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+Before being able to use any of the Mitel::OIG classes to interact with OIG
+services, you will need to setup a valid configuration. The code package already
+incorporates the various WSDLs for the OIG services, but configuration for where
+to access your specific endpoint is necessary. Configuration is handled globally
+by the Mitel::OIG::Configuration class and you can set it up like so:
+
+```ruby
+Mitel::OIG::Configuration.set(:endpoint, 'https://192.168.0.1:8080')
+Mitel::OIG::Configuration.set(:application_name, 'MyOIGApp')
+Mitel::OIG::Configuration.set(:application_password, 'secret')
+Mitel::OIG::Configuration.set(:company_name, 'MyCompany')
+Mitel::OIG::Configuration.set(:local_password, 'secret')
+```
+
+All the options described above are required to properly authenticate your
+application with the OIG services. All these credentials are shared globally
+within your application and are automatically accessible to the classes provided
+by this gem.
 
 ## Contributing
 

data/Rakefile

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

data/lib/mitel/oig/configuration.rb

@@ -0,0 +1,48 @@
+require 'singleton'
+
+module Mitel
+  module OIG
+    class Configuration
+      include Singleton
+
+      def self.set(option, value)
+        instance.set(option, value)
+        instance
+      end
+
+      def set(option, value)
+        options
+        @options[option.to_sym] = value
+        setup_accessors(option)
+        self
+      end
+
+      def self.clear(option)
+        instance.clear(option)
+        instance
+      end
+
+      def clear(option)
+        options
+        @options[option.to_sym] = nil
+        self
+      end
+
+      def self.options
+        instance.options
+      end
+
+      def options
+        @options ||= {}
+      end
+
+      def self.method_missing(method_sym, *_arguments, &_block)
+        instance.send(method_sym, _arguments, _block)
+      end
+
+      def method_missing(method_sym, *_arguments, &_block)
+        options[method_sym]
+      end
+    end
+  end
+end

data/lib/mitel/oig/version.rb

@@ -1,5 +1,5 @@
 module Mitel
   module OIG
-    VERSION = "0.0.1"
+    VERSION = '0.0.2'
   end
 end

data/lib/mitel_oig.rb

@@ -1,5 +1,7 @@
 require 'mitel/oig/version'
 
+require 'mitel/oig/configuration'
+
 module Mitel
   module OIG
     # Your code goes here...

data/mitel_oig.gemspec

@@ -18,10 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w{lib}
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.1.0'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 
   spec.add_dependency 'savon', '~> 2.0'
 end

data/spec/mitel/oig/configuration_spec.rb

@@ -0,0 +1,49 @@
+RSpec.describe Mitel::OIG::Configuration do
+  it 'responds to .set' do
+    expect(Mitel::OIG::Configuration).to respond_to(:set)
+  end
+
+  it 'responds to .clear' do
+    expect(Mitel::OIG::Configuration).to respond_to(:clear)
+  end
+
+  it 'responds to .options' do
+    expect(Mitel::OIG::Configuration).to respond_to(:options)
+  end
+
+  describe '.set' do
+    it 'sets the option' do
+      Mitel::OIG::Configuration.set(:endpoint, 'http://localhost')
+      expect(Mitel::OIG::Configuration.options[:endpoint]).to eq('http://localhost')
+    end
+
+    it 'exposes option as a method' do
+      Mitel::OIG::Configuration.set(:endpoint, 'http://localhost')
+      expect(Mitel::OIG::Configuration.endpoint).to eq('http://localhost')
+    end
+  end
+
+  describe '.clear' do
+    before(:each) do
+      Mitel::OIG::Configuration.set(:endpoint, 'http://localhost')
+    end
+
+    it 'clears the option' do
+      Mitel::OIG::Configuration.clear(:endpoint)
+      expect(Mitel::OIG::Configuration.options[:endpoint]).to eq(nil)
+      expect(Mitel::OIG::Configuration.endpoint).to eq(nil)
+    end
+  end
+
+  describe '.options' do
+    let(:subject) { Mitel::OIG::Configuration.options }
+
+    before(:each) do
+      Mitel::OIG::Configuration.set(:endpoint, 'http://localhost')
+    end
+
+    it 'exposes options as Hash' do
+      expect(subject[:endpoint]).to eq('http://localhost')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require(:default)
+
+if ENV['CI']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+else
+  require 'simplecov'
+  SimpleCov.start
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  #config.filter_run :focus
+  #config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 3
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mitel_oig
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - James Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: savon
   requirement: !ruby/object:Gem::Requirement
@@ -88,15 +102,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/mitel/oig/configuration.rb
 - lib/mitel/oig/version.rb
 - lib/mitel_oig.rb
 - mitel_oig.gemspec
+- spec/mitel/oig/configuration_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/plainprogrammer/mitel_oig
 licenses:
 - MIT
@@ -121,4 +140,6 @@ rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: A client library for Mitel's OIG service.
-test_files: []
+test_files:
+- spec/mitel/oig/configuration_spec.rb
+- spec/spec_helper.rb