voxbone-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe08e01083e7a6fe667dc820b5d8f35059d74ce5
+  data.tar.gz: f8f4e1d57a3610ccd10207f2b5d03b5e43bb5574
+SHA512:
+  metadata.gz: 7cce10925e258517cc299633a41436ddf6b57feee641ecc40c00682fd213a8af1526ce9df12c4fce7af4b46585d44508ec9eee7d2a505753e6c130657e9a68a9
+  data.tar.gz: fda26751c9ea902abccbbd6f2d2c0765a7e2a583cb35afc6b70f8533ec64b12042140349297b4898b85e13ab0422de279769bde72d26c14f8c9535a60de09459

data/.gitignore

@@ -0,0 +1 @@
+voxbone-ruby-*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    voxbone-ruby (0.0.1)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    multi_xml (0.5.5)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rspec (~> 3.0)
+  voxbone-ruby!
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,9 @@
+# voxbone-ruby
+
+A Ruby client for Voxbone's REST API.
+
+# Supported Methods
+
+## Inventory
+
+- `Voxbone#list_did_group`

data/lib/voxbone/config.rb

@@ -0,0 +1,29 @@
+module Voxbone
+  module Config
+    attr_accessor :username, :password, :environment
+
+    ENVIRONMENTS = {
+      production: 'https://api.voxbone.com/ws-voxbone/services/rest/',
+      sandbox: 'https://sandbox.voxbone.com/ws-voxbone/services/rest/'
+    }.freeze
+
+    class ConfigError < StandardError; end
+
+    def configure
+      yield(self)
+    end
+
+    def environment=(environment_name)
+      environment_name = environment_name.to_sym
+      Voxbone.base_uri ENVIRONMENTS.fetch environment_name
+      @environment = environment_name
+    rescue KeyError
+      raise(
+        ConfigError,
+        "#{environment_name} is not a valid environment. Instead, use one of " \
+        "the following: #{ENVIRONMENTS.keys}")
+    end
+  end
+
+  extend Config
+end

data/lib/voxbone/inventory.rb

@@ -0,0 +1,59 @@
+module Voxbone
+  module Inventory
+    # List DID Group
+    #
+    # `list_did_group` allows you to retrieve the list of DID groups. A DID
+    # group can be defined as the smallest set of DIDs which is usually DIDs
+    # that share the same city or area code attributes. It is a method which is
+    # useful to get pricing info on a DID and to get didGroupIds which is a
+    # required parameter when placing a DID order.
+    #
+    # options - Type: Hash. Parameters used to refine the selection.
+    #           :country_code_a3   - Type: String. Indicates the country code of
+    #                                the DID group in its ISO 3166-1 alpha-3
+    #                                format (e.g. "GBR" for United Kingdom,
+    #                                "USA" for United States of America, "BEL"
+    #                                for Belgium, etc.). (required)
+    #           :page_number       - Type: Integer. The page number, starting at
+    #                                0. (required)
+    #           :page_size         - Type: Integer. The page size (max number of
+    #                                entities that are displayed in the
+    #                                response). (required)
+    #           :did_group_ids     - Type: Integer (multiple). Can be used if
+    #                                you want information about specific DID
+    #                                groups.
+    #           :state_id          - Type: String. The numerical identifier for
+    #                                the didGroup's state. Please see the
+    #                                `list_state` operation to retrieve a valid
+    #                                state identifier.
+    #           :city_name_pattern - Type: String. A string pattern for the
+    #                                beginning of city name: "New York%" will
+    #                                return all New York DID groups. On the
+    #                                contrary, "w York%" will return none.
+    #           :rate_center       - Type: String. The rate center can be
+    #                                defined as a zone (which can be equivalent
+    #                                to a city or the area of a city) e.g. the
+    #                                rate center of "NEW YORK CITY ZONE 1" would
+    #                                be "NWYRCYZN01". The rate center is a
+    #                                notion usually used in north America.
+    #           :area_code         - Type: String. The area code of the DID
+    #                                group (e.g. "646").
+    #           :did_type          - Type: String. The type of DID. The possible
+    #                                values are GEOGRAPHIC, TOLL_FREE, NATIONAL,
+    #                                MOBILE, SHARED_COST, SPECIAL, or INUM.
+    #           :show_empty        - Type: Boolean. Set to true if you want to
+    #                                show the didGroups with no stock currently
+    #                                available.
+    #           :feature_ids       - Type: Integer (multiple). Can be used if
+    #                                you want to list DID groups that support
+    #                                certain features such as VoxSMS or VoxFAX.
+    #                                (eg. 6 for VoxFAX, 25 for VoxSMS). Note
+    #                                that you can specify multiple features by
+    #                                repeating the query parameter.
+    def list_did_group(**options)
+      get('/inventory/didgroup', options)
+    end
+  end
+
+  extend Inventory
+end

data/lib/voxbone/version.rb

@@ -0,0 +1,3 @@
+module Voxbone
+  VERSION = '0.0.2'.freeze
+end

data/lib/voxbone/voxbone.rb

@@ -0,0 +1,30 @@
+require 'httparty'
+require 'forwardable'
+
+module Voxbone
+  include HTTParty
+
+  HEADERS = {
+    'Content-Type' => 'application/json',
+    'Accept' => 'application/json'
+  }.freeze
+
+  class << self
+    def get(path, **options)
+      auth = { username: username, password: password }
+      query = camelize_keys(options) if options
+      super(
+        path, query: query, headers: HEADERS, basic_auth: auth)
+    end
+
+    def camelize_keys(hash)
+      Hash[hash.map { |key, value| [camelize(key), value] }]
+    end
+
+    def camelize(string)
+      parts = string.to_s.split('_')
+      transformed_parts = parts[1..-1].map(&:capitalize).unshift(parts[0])
+      transformed_parts.join
+    end
+  end
+end

data/lib/voxbone.rb

@@ -0,0 +1,5 @@
+require 'voxbone/voxbone'
+require 'voxbone/version'
+require 'voxbone/config'
+
+require 'voxbone/inventory'

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'voxbone'
+
+Voxbone.configure do |config|
+  config.username = 'test_user'
+  config.password = 'test_password'
+  config.environment = 'sandbox'
+end

data/spec/voxbone/inventory_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Voxbone::Inventory do
+  describe '#list_did_group' do
+    it 'correctly makes the request' do
+      expect(Voxbone).to receive(:get).with(
+        '/inventory/didgroup',
+        country_code_a3: 'USA', page_number: 0, page_size: 5, area_code: '225')
+
+      Voxbone.list_did_group(
+        country_code_a3: 'USA', page_number: 0, page_size: 5, area_code: '225')
+    end
+  end
+end

data/voxbone-ruby.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/voxbone/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'voxbone-ruby'
+  s.authors = ['Julien Negrotto']
+  s.email = ['jtnegrotto@gmail.com']
+  s.summary = "A gem for interacting with Voxbone's REST API."
+  s.description = "A gem for interacting with Voxbone's REST API"
+  s.homepage = ''
+
+  s.platform = Gem::Platform::RUBY
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec`.split("\n")
+  s.require_paths = ['lib']
+  s.version = Voxbone::VERSION
+
+  s.add_runtime_dependency 'httparty'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: voxbone-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Julien Negrotto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: bundler
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem for interacting with Voxbone's REST API
+email:
+- jtnegrotto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/voxbone.rb
+- lib/voxbone/config.rb
+- lib/voxbone/inventory.rb
+- lib/voxbone/version.rb
+- lib/voxbone/voxbone.rb
+- spec/spec_helper.rb
+- spec/voxbone/inventory_spec.rb
+- voxbone-ruby.gemspec
+homepage: ''
+licenses: []
+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.1
+signing_key: 
+specification_version: 4
+summary: A gem for interacting with Voxbone's REST API.
+test_files:
+- spec/spec_helper.rb
+- spec/voxbone/inventory_spec.rb
+has_rdoc: