oneview 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 337b3c6c73272b1e4a069237f95499346f7b3619
+  data.tar.gz: 9e06ccc674980568d53415a18ac8e1e8577640ad
+SHA512:
+  metadata.gz: c6ed23b47f36b2be135378138eb90c17748d4e014d0b3bb893f25a16f8de3fc471274f39b7ebf22a4756898e82fb38f00dad8c5621c7db6f0d38a0d383cc020a
+  data.tar.gz: 03fa1ea3b56b509cf05586c7dde79a26f79e9b3a2cff753179ca6642c955c99a072ee97548afbb7cc888bd48fe13e8543f872b353baa064f734254d0d3b74cd8

data/.gitignore

@@ -0,0 +1,41 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.project
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+.rvmrc

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+- 2.0.0
+
+addons:
+  code_climate:
+    repo_token: 5b5c9617f7250055e1b48d7f1297c5b36a6861d9431607a8b310dc22dc046ba8
+    
+bundler_args: --without development
+
+notifications:
+  email:
+    recipients:
+      - gberdugo@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in oneview.gemspec
+gemspec
+
+gem 'debugger', :group => :development

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gustavo Berdugo
+
+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,68 @@
+# Oneview
+
+[![Build Status](https://travis-ci.org/coyosoftware/oneview.svg?branch=master)](https://travis-ci.org/coyosoftware/oneview) [![Gem Version](https://badge.fury.io/rb/oneview.png)](http://badge.fury.io/rb/oneview) [![Test Coverage](https://codeclimate.com/github/coyosoftware/oneview/badges/coverage.svg)](https://codeclimate.com/github/coyosoftware/oneview) [![Code Climate](https://codeclimate.com/github/coyosoftware/oneview/badges/gpa.svg)](https://codeclimate.com/github/coyosoftware/oneview)
+
+This gem simplifies the usage of [Oneview](http://www.oneview.com.br/) API
+
+For more information regarding the API, visit the [documentation]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'oneview'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oneview
+
+## Usage
+
+Create a new instance of Oneview class passing your access token:
+
+```ruby
+	client = Oneview.new(YOUR_ACCESS_TOKEN)
+```	
+
+With the client instance, you can access the following resources:
+
+* Contacts (client.contacts) **Only creation**
+* Sms Sending (client.sms) **Not Implemented Yet**
+* Email Sending (client.email) **Not Implemented Yet**
+
+## Using the resources
+### Creating new records
+All resources implement a **create** method.
+
+It can accept a hash with the parameters as described in the API [documentation] or an Entity object that reflects the API fields.
+
+Currently the following entities are implemented:
+
+* [Contact](lib/oneview/entity/contact.rb)
+* [Phone](lib/oneview/entity/phone.rb)
+* [Dynamic Field](lib/oneview/entity/dynamic_field.rb)
+
+### Reading the response
+All methods return an Oneview::Client::Response object. This objects contains the following attributes:
+
+```ruby
+	response = Oneview.new(YOUR_ACCESS_TOKEN).contacts.create(contact_entity)
+	
+	response.status			# Contains the status code of the request
+	response.payload		# Contains the return data (JSON) of the request
+	response.raw_response	# Contains the HTTParty response object
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/coyosoftware/oneview/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
+
+[documentation]: http://coyosoftware.github.io/

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec

data/lib/oneview.rb

@@ -0,0 +1,36 @@
+require "oneview/version"
+
+module Oneview
+  LIBNAME = 'oneview'
+  LIBDIR = File.expand_path("../#{LIBNAME}", __FILE__)
+  
+  class << self
+    def included(base)
+      base.extend ClassMethods
+    end
+
+    def new(access_token)
+      Client.new(access_token)
+    end
+  end
+  
+  module ClassMethods
+    # Requires internal libraries
+    #
+    # @param [String] prefix
+    # the relative path prefix
+    # @param [Array[String]] libs
+    # the array of libraries to require
+    #
+    # @return [self]
+    def require_all(prefix, *libs)
+      libs.each do |lib|
+        require "#{File.join(prefix, lib)}"
+      end
+    end
+  end
+  
+  extend ClassMethods
+  
+  require_all LIBDIR, 'client'
+end

data/lib/oneview/api/contacts.rb

@@ -0,0 +1,21 @@
+module Oneview
+  module Api
+    class Contacts < Client
+      require_all 'oneview/entity', 'contact', 'dynamic_field', 'phone'
+      
+      base_uri "http://www.oneview.com.br/api/contacts"
+      
+      def create(data)
+        return parse_response(self.class.post("/", :body => build_body(data), :headers => header)) if data.is_a?(Hash)
+        return parse_response(self.class.post("/", :body => build_body(data.as_parameter), :headers => header)) if data.is_a?(Oneview::Entity::Contact)
+        raise ArgumentError
+      end
+      alias :new :create
+      
+      private
+        def build_body(parameters)
+          super({:contact => parameters})
+        end
+    end
+  end
+end

data/lib/oneview/client.rb

@@ -0,0 +1,50 @@
+require "httparty"
+
+module Oneview
+  class Client
+    class NoAccessTokenError < StandardError
+      def message
+        "Please provide an access token"
+      end  
+    end
+    
+    extend Oneview::ClassMethods
+    include HTTParty
+    
+    require_all 'oneview/api', 'contacts'
+    
+    attr_accessor :access_token
+    
+    def initialize(access_token)
+      raise NoAccessTokenError if access_token.nil? || access_token.strip == ""
+      @access_token = access_token
+    end
+    
+    def contacts
+      Oneview::Api::Contacts.new(@access_token)
+    end
+    
+    protected
+      def header
+        {"Content-Type" => "application/json", "Accept" => "application/json"}
+      end
+      
+      def build_body(parameters)
+        parameters.merge(:access_token => @access_token).to_json
+      end
+      
+      def parse_response(response)
+        return Oneview::Client::Response.new(response)
+      end
+    
+    class Response
+      attr_accessor :status, :payload, :raw_response
+      
+      def initialize(response)
+        @status = response.code
+        @payload = response.parsed_response
+        @raw_response = response
+      end
+    end
+  end
+end

data/lib/oneview/entity/contact.rb

@@ -0,0 +1,30 @@
+module Oneview
+  module Entity
+    class Contact
+      attr_accessor :id, :name, :birthday, :email, :city, :state, :zip_code, :address, :phone, :dynamic_fields
+      
+      def initialize
+        self.phone = Phone.new
+        self.dynamic_fields = Array.new
+      end
+      
+      def as_parameter
+        variables = instance_variables.map do |name|
+          case name
+            when :@phone
+              ["phone_attributes", instance_variable_get(name).as_parameter]
+            when :@dynamic_fields
+            else 
+              [name.to_s.tr("@", ""), instance_variable_get(name)]
+          end
+        end
+        
+        self.dynamic_fields.each do |dynamic_field|
+          variables << [dynamic_field.name, dynamic_field.value]
+        end
+        
+        Hash[variables.compact]
+      end
+    end
+  end
+end

data/lib/oneview/entity/dynamic_field.rb

@@ -0,0 +1,17 @@
+module Oneview
+  module Entity
+    class DynamicField
+      attr_accessor :name, :value
+      
+      def as_parameter
+        variables = instance_variables.map do |name|
+          variable_name = name.to_s.tr("@", "")
+          
+          [variable_name, instance_variable_get(name)]
+        end
+         
+        Hash[variables]
+      end
+    end
+  end
+end

data/lib/oneview/entity/phone.rb

@@ -0,0 +1,17 @@
+module Oneview
+  module Entity
+    class Phone
+      attr_accessor :id, :number, :area_code, :country_code
+      
+      def as_parameter
+        variables = instance_variables.map do |name|
+          variable_name = name.to_s.tr("@", "")
+          
+          [variable_name, instance_variable_get(name)]
+        end
+         
+        Hash[variables]
+      end
+    end
+  end
+end

data/lib/oneview/version.rb

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

data/oneview.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oneview/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oneview"
+  spec.version       = Oneview::VERSION
+  spec.authors       = ["Gustavo Berdugo"]
+  spec.email         = ["gberdugo@gmail.com"]
+  spec.summary       = %q{This gem provides integration with Oneview APIs (http://www.oneview.com.br/)}
+  spec.description   = %q{The goal of this gem is to simplify the access to Oneview API (http://www.oneview.com.br/), for more information about this API, visit: http://coyosoftware.github.io/}
+  spec.homepage      = "https://github.com/coyosoftware/oneview"
+  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_dependency('httparty', "~> 0.13")
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "webmock", "~> 1.20"
+end

data/spec/oneview/api/contacts_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+RSpec.describe Oneview::Api::Contacts do
+  describe "creating" do
+    let(:contact_params) {{:contact => {:name => "name", :email => "email"}, :access_token => "abc"}}
+    let(:header) {{"Content-Type" => "application/json", "Accept" => "application/json"}}
+    
+    before(:each) do
+      dynamic_field = Oneview::Entity::DynamicField.new
+      dynamic_field.name = "dynamic_field"
+      dynamic_field.value = "123"
+      
+      phone = Oneview::Entity::Phone.new
+      phone.country_code = "+55"
+      phone.area_code = "12"
+      phone.number = "998998789"
+      
+      @contact = Oneview::Entity::Contact.new
+      @contact.name = "name"
+      @contact.email = "email@email.com"
+      @contact.birthday = "14/10/2014"
+      @contact.city = "city"
+      @contact.state = "state"
+      @contact.zip_code = "12233-444"
+      @contact.phone = phone
+      @contact.dynamic_fields << dynamic_field
+      
+      stub_request(:post, "http://www.oneview.com.br/api/contacts/").to_return(:status => 200)
+    end
+    
+    describe "with raw parameters" do
+      it "should post to the contacts url" do
+        expect(Oneview::Api::Contacts).to receive(:post).with("/", :body => contact_params.to_json, :headers => header).and_call_original
+        
+        Oneview.new("abc").contacts.create({:name => "name", :email => "email"})
+      end
+    end
+    
+    describe "with entity parameter" do
+      it "should post to the contacts url" do
+        expect(Oneview::Api::Contacts).to receive(:post).with("/", :body => {:contact => @contact.as_parameter, :access_token => "abc"}.to_json, :headers => header).and_call_original
+        
+        Oneview.new("abc").contacts.create(@contact)
+      end
+    end
+    
+    describe "with invalid parameter" do
+      it "should raise ArgumentError when passing neither a Hash nor a Contact" do
+        expect{Oneview.new("abc").contacts.create(Array.new)}.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/oneview/client_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+RSpec.describe Oneview::Client do
+  before(:each) do
+    Oneview::Client.send(:public, *Oneview::Client.protected_instance_methods)  
+  end
+  
+  it "should raise NoAccessTokenError when creating a new client without the access token" do
+    expect{Oneview::Client.new("")}.to raise_error(Oneview::Client::NoAccessTokenError, "Please provide an access token")
+  end
+  
+  it "should return the correct headers" do
+    expect(Oneview::Client.new("abc").header).to eq({"Content-Type" => "application/json", "Accept" => "application/json"})
+  end
+  
+  it "should append the access token to the parameters" do
+    expect(Oneview::Client.new("abc").build_body({:abc => "abc", :def => "def"})).to eq({:abc => "abc", :def => "def", :access_token => "abc"}.to_json)
+  end
+  
+  it "should return an Oneview::Client::Response with the status" do
+    stub_request(:post, "http://www.oneview.com.br/api/contacts/").to_return(:status => 200)
+    
+    response = Oneview.new("abc").contacts.create({:name => "name"})
+    
+    expect(response.class).to eq(Oneview::Client::Response)
+    expect(response.status).to eq(200)
+  end
+end

data/spec/oneview/entity/contact_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+RSpec.describe Oneview::Entity::Contact do
+  describe "as_parameter" do
+    let(:contact_as_parameter) {{"name" => "name", "email" => "email@email.com", "birthday" => "14/10/2014", "city" => "city", "state" => "state",
+      "zip_code" => "12233-444", "phone_attributes" => {"country_code" => "+55", "area_code" => "12", "number" => "998998789"}, 
+      "dynamic_field" => "123"}}
+      
+    it "should return the contact as parameter" do
+      contact = Oneview::Entity::Contact.new
+      
+      contact.name = "name"
+      contact.email = "email@email.com"
+      contact.birthday = "14/10/2014"
+      contact.city = "city"
+      contact.state = "state"
+      contact.zip_code = "12233-444"
+      
+      phone = Oneview::Entity::Phone.new
+      phone.country_code = "+55"
+      phone.area_code = "12"
+      phone.number = "998998789"
+      
+      contact.phone = phone
+      
+      dynamic_field = Oneview::Entity::DynamicField.new
+      dynamic_field.name = "dynamic_field"
+      dynamic_field.value = "123"
+      
+      contact.dynamic_fields << dynamic_field
+      
+      expect(contact.as_parameter).to eq(contact_as_parameter)
+    end
+  end
+end

data/spec/oneview/entity/dynamic_field_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+RSpec.describe Oneview::Entity::DynamicField do
+  describe "as_parameter" do
+    let(:dynamic_field_as_parameter) {{"name" => "dynamic_field", "value" => "abc"}}
+      
+    it "should return the dynamic_field as parameter" do
+      dynamic_field = Oneview::Entity::DynamicField.new
+      dynamic_field.name = "dynamic_field"
+      dynamic_field.value = "abc"
+      
+      expect(dynamic_field.as_parameter).to eq(dynamic_field_as_parameter)
+    end
+  end
+end

data/spec/oneview/entity/phone_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+RSpec.describe Oneview::Entity::Phone do
+  describe "as_parameter" do
+    let(:phone_as_parameter) {{"number" => "999999999", "area_code" => "12", "country_code" => "+55"}}
+      
+    it "should return the phone as parameter" do
+      phone = Oneview::Entity::Phone.new
+      phone.country_code = "+55"
+      phone.area_code = "12"
+      phone.number = "999999999"
+      
+      expect(phone.as_parameter).to eq(phone_as_parameter)
+    end
+  end
+end

data/spec/oneview_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe Oneview do
+  it "should return a new Oneview::Client" do
+    expect(Oneview.new("abc").class).to eq(Oneview::Client)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'debugger'
+require 'oneview'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: oneview
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gustavo Berdugo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: 'The goal of this gem is to simplify the access to Oneview API (http://www.oneview.com.br/),
+  for more information about this API, visit: http://coyosoftware.github.io/'
+email:
+- gberdugo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/oneview.rb
+- lib/oneview/api/contacts.rb
+- lib/oneview/client.rb
+- lib/oneview/entity/contact.rb
+- lib/oneview/entity/dynamic_field.rb
+- lib/oneview/entity/phone.rb
+- lib/oneview/version.rb
+- oneview.gemspec
+- spec/oneview/api/contacts_spec.rb
+- spec/oneview/client_spec.rb
+- spec/oneview/entity/contact_spec.rb
+- spec/oneview/entity/dynamic_field_spec.rb
+- spec/oneview/entity/phone_spec.rb
+- spec/oneview_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/coyosoftware/oneview
+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.2
+signing_key: 
+specification_version: 4
+summary: This gem provides integration with Oneview APIs (http://www.oneview.com.br/)
+test_files:
+- spec/oneview/api/contacts_spec.rb
+- spec/oneview/client_spec.rb
+- spec/oneview/entity/contact_spec.rb
+- spec/oneview/entity/dynamic_field_spec.rb
+- spec/oneview/entity/phone_spec.rb
+- spec/oneview_spec.rb
+- spec/spec_helper.rb