tropo-provisioning 0.0.21 → 0.0.22

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    tropo-provisioning (0.0.21)
+      activesupport
+      hashie (>= 0.2.1)
+      i18n
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    hashie (1.1.0)
+    i18n (0.6.0)
+    multi_json (1.0.3)
+    rdoc (3.9.4)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    yard (0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  rdoc
+  rspec
+  tropo-provisioning!
+  yard

data/README.rdoc

@@ -19,14 +19,17 @@ The Tropo Provisioning gem provides a library for convenient access to the Tropo
 == Requirements
 
 * Unit tests passed on: Ruby MRI v1.8.6/1.8.7, Ruby 1.9.2, JRuby 1.5.0 and MacRuby 0.6
-* RubyGems
+
+* RubyGems: Check tropo-provisioning.gemspec
 
 == Installation
 
-  $ sudo gem install tropo-provisioning
+    $ gem install tropo-provisioning
 
 == Usage
 
+Any HTTP method can be accessed using the TropoProvisioning wrapper:
+
   require 'rubygems'
   require 'tropo-provisioning'
 
@@ -62,8 +65,11 @@ The Tropo Provisioning gem provides a library for convenient access to the Tropo
 
 ==== Tropo Provisioning API Documentation
 
-  TBD
-
+    git clone https://github.com/tropo/tropo-provisioning
+    cd tropo-provisioning
+    bundle install
+    rake rdoc
+	
 === Local & Generating Documentation
 
 ==== Developer

data/Rakefile

@@ -1,46 +1,31 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "tropo-provisioning"
-    gem.summary = "Library for interacting with the Tropo Provisioning API"
-    gem.description = "Library for interacting with the Tropo Provisioning API"
-    gem.email = "jsgoecke@voxeo.com"
-    gem.homepage = "http://github.com/voxeo/tropo-provisioning"
-    gem.authors = ["Jason Goecke"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_dependency "hashie", ">= 0.2.1"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
+task :default => [:test]
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
+require 'tropo-provisioning/version'
+
+
+RSpec::Core::RakeTask.new(:test) do |spec|
+    spec.skip_bundler = true
+    spec.pattern = ['spec/*_spec.rb']
+    spec.rspec_opts = '--color --format doc'
 end
 
-task :spec => :check_dependencies
 
-task :default => :spec
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rcov = true
+end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+RDoc::Task.new do |rdoc|
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "tropo-provisioning #{version}"
+  rdoc.title = "tropo-provisioning #{TropoProvisioning::VERSION}"
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.options << '-c' << 'utf-8'
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/examples/app_details.yml

@@ -0,0 +1,3 @@
+--- !map:Hashie::Mash 
+href: http://api.tropo.com/v1/applications/128973
+application_id: "128973"

data/examples/authenticate_account.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'yaml'
+require 'lib/tropo-provisioning'
+
+config = YAML.load(File.open('examples/config.yml'))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], :base_uri => 'http://172.16.10.125:8080/provisioning')
+
+# Create an account
+p provisioning.authenticate_account('jsgoecke', 'test123')
+

data/examples/config.yml

@@ -0,0 +1,5 @@
+tropo:
+    username: jsgoecke
+    password: sancar119
+
+filename: app_details.yml

data/examples/create_invitation.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'lib/tropo-provisioning'
+
+config = YAML.load(File.open('examples/config.yml'))
+app_details = YAML.load(File.open("examples/#{config['filename']}"))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], { :base_uri => 'http://api-smsified-eng.voxeo.net/v1'})
+
+p provisioning.create_invitation({ :code   => 'ABC457',
+                                   :count  => 100,
+                                   :credit => 10 })

data/examples/delete_applications.rb

@@ -0,0 +1,25 @@
+## WARNING ##
+# IF YOU RUN THIS SCRIPT, IT WILL DELETE ALL OF YOUR APPLICATIONS #
+## WARNING ##
+
+require 'rubygems'
+require 'lib/tropo-provisioning'
+
+config = YAML.load(File.open('examples/config.yml'))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], 
+                                     config['tropo']['password'], 
+                                     :base_uri => 'http://api.tropo.com/provisioning')
+                                     
+applications = provisioning.applications
+
+p applications
+
+applications.each do |app|
+  provisioning.delete_application(app.application_id)
+end
+
+## WARNING ##
+# IF YOU RUN THIS SCRIPT, IT WILL DELETE ALL OF YOUR APPLICATIONS #
+## WARNING ##

data/examples/get_balance.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'yaml'
+require 'lib/tropo-provisioning'
+
+config = YAML.load(File.open('examples/config.yml'))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], :base_uri => 'http://api-smsified-eng.voxeo.net/v1')
+
+# Create an account
+p provisioning.balance('54228')

data/examples/list_applications_with_addresses.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'lib/tropo-provisioning'
+
+config = YAML.load(File.open('examples/config.yml'))
+app_details = YAML.load(File.open("examples/#{config['filename']}"))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'])
+
+# Then you may iterate through all of your configured applications
+provisioning.applications_with_addresses.each do |app|
+  p app
+  puts '*'*10
+end
+
+# Now list a single application
+p '<===============>'
+p provisioning.application_with_address('124780')

data/examples/list_features.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'yaml'
+require 'lib/tropo-provisioning'
+
+config = YAML.load(File.open('examples/config.yml'))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], :base_uri => 'http://api-smsified-eng.voxeo.net/v1')
+
+# List availble features
+p provisioning.features
+
+# List features configured for a user
+p provisioning.user_features('54228')
+
+p provisioning.user_enable_feature('54228', 'http://api-smsified-eng.voxeo.net/v1/users/12345/features/8')

data/examples/list_invitations.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'lib/tropo-provisioning'
+
+config = YAML.load(File.open('examples/config.yml'))
+app_details = YAML.load(File.open("examples/#{config['filename']}"))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], { :base_uri => 'http://api-smsified-eng.voxeo.net/v1'})
+
+# Then you may iterate through all of your configured addresses
+provisioning.invitations.each do |invitation|
+  p invitation
+end
+
+p provisioning.invitation('ABC456')
+
+p provisioning.user_invitations '15909'
+
+p provisioning.user_invitation '15909', 'ABC456'

data/examples/list_partitions_platforms.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'yaml'
+require 'lib/tropo-provisioning'
+require 'json'
+
+config = YAML.load(File.open('examples/config.yml'))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], :base_uri => 'http://api-smsified-eng.voxeo.net/v1')
+
+# Create an account
+p provisioning.partitions
+p provisioning.platforms('staging')
+
+

data/examples/list_payment_method.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'yaml'
+require 'lib/tropo-provisioning'
+
+config = YAML.load(File.open('examples/config.yml'))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], :base_uri => 'http://api-smsified-eng.voxeo.net/v1')
+
+# Create an account
+p provisioning.user_payment_method('54240')

data/examples/list_payment_methods.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'yaml'
+require 'lib/tropo-provisioning'
+
+config = YAML.load(File.open('examples/config.yml'))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], :base_uri => 'http://api-smsified-eng.voxeo.net/v1')
+
+# Create an account
+p provisioning.available_payment_types

data/examples/list_user.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'yaml'
+require 'lib/tropo-provisioning'
+require 'json'
+
+config = YAML.load(File.open('examples/config.yml'))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], :base_uri => 'http://api-smsified-eng.voxeo.net/v1')
+
+# Create an account
+#p provisioning.user('54238')
+p provisioning.user('mcervantes')
+#p provisioning.search_users('username=foobar')
+

data/examples/modify_user.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'yaml'
+require 'lib/tropo-provisioning'
+require 'json'
+
+config = YAML.load(File.open('examples/config.yml'))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], :base_uri => 'http://api-smsified-eng.voxeo.net/v1')
+
+# Create an account
+p provisioning.modify_user('54228', { :marketing_opt_in => false })
+
+
+

data/examples/update_invitation.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'lib/tropo-provisioning'
+
+config = YAML.load(File.open('examples/config.yml'))
+app_details = YAML.load(File.open("examples/#{config['filename']}"))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], { :base_uri => 'http://api-smsified-eng.voxeo.net/v1'})
+
+p provisioning.update_invitation('ABC456', :count   => '200')

data/examples/users_search.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'yaml'
+require 'lib/tropo-provisioning'
+require 'json'
+
+config = YAML.load(File.open('examples/config.yml'))
+
+# Create a new provisioning object with your Tropo credentials
+provisioning = TropoProvisioning.new(config['tropo']['username'], config['tropo']['password'], :base_uri => 'http://api.smsified.com/v1')
+
+# Create an account
+p provisioning.search_users 'username=jsg'
+
+p provisioning.username_exists? 'jsgoecke'
+p provisioning.username_exists? 'fooeyfooy'

data/lib/tropo-provisioning.rb

@@ -1,2 +1,2 @@
-$: << File.expand_path(File.dirname(__FILE__))
-%w(net/http net/https uri active_support active_support/json active_support/inflector hashie tropo-provisioning/tropo-provisioning tropo-provisioning/error.rb).each { |lib| require lib }
+
+require 'tropo-provisioning/tropo_provisioning'

data/lib/tropo-provisioning/tropo_client.rb

@@ -0,0 +1,211 @@
+require 'active_support'
+require 'active_support/json'
+require 'hashie'
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+# This class is in charge of handling HTTP requests to the Tropo HTTP endpoint
+class TropoClient
+  
+  autoload :TropoError, 'tropo-provisioning/tropo_error'
+
+  # required HTTP headers
+  attr_accessor :headers
+  # Tropo provisioning API endpoint
+  attr_reader :base_uri
+  # Valid Tropo username
+  attr_reader :username
+  # password associated to :username
+  attr_reader :password
+  
+  ##
+  # Creates a new TropoClient instance
+  #
+  # ==== Parameters
+  # * [required, String] *username* valid Tropo username
+  # * [required, String] *password* valid password
+  # * [optional, String] *base_uri* Tropo provisioning API endpoint
+  # * [optional, String] *headers* required HTTP headers
+  #
+  # ==== Return
+  # * new TropoClient instance
+  def initialize(username, password, base_uri = "http://api.tropo.com/v1", headers)
+    @base_uri = base_uri
+    @username = username
+    @password = password
+    @headers = headers.nil? ? {} : headers
+  end
+  
+  ##
+  # Send a HTTP Get
+  #
+  # ==== Parameters
+  # * [optional, String] path URI
+  # * [optional, Hash] Query parameters
+  #
+  # ==== Return
+  # JSON decoded object
+  def get(resource = "", params = {})
+    uri = "#{base_uri}#{resource}"
+    params.empty? or uri = uri.concat('?').concat(params.collect { |k, v| "#{k}=#{v.to_s}" }.join("&"))
+    request(Net::HTTP::Get.new(uri))
+  end
+  
+  ##
+  # Send a HTTP Post
+  #
+  # ==== Parameters
+  # * [optional, String] resource path URI
+  # * [optional, Hash] params body to be JSON encoded
+  #
+  # ==== Return
+  # JSON decoded object
+  def post(resource = "", params = {})
+    uri = "#{base_uri}#{resource}"
+    request(Net::HTTP::Post.new(uri), params)
+  end
+  
+  ##
+  # Send a HTTP Delete
+  #
+  # ==== Parameters
+  # * [optional, String] resource path URI
+  # * [optional, Hash] Query parameters
+  #
+  # ==== Return
+  # JSON decoded object
+  def delete(resource = "", params = {})
+    uri = "#{base_uri}#{resource}"
+    params.empty? or uri = uri.concat('?').concat(params.collect { |k, v| "#{k}=#{v.to_s}" }.join("&"))
+    request(Net::HTTP::Delete.new(uri))
+  end
+
+  ##
+  # Send a HTTP Put
+  #
+  # ==== Parameters
+  # * [optional, String] resource path URI
+  # * [optional, Hash] params body to be JSON encoded
+  #
+  # ==== Return
+  # JSON decoded object
+  def put(resource = "", params = {})
+    uri = "#{base_uri}#{resource}"
+    request(Net::HTTP::Put.new(uri), params)
+  end
+
+  ##
+  # Format the parameters
+  #
+  # ==== Parameters
+  # * [required, Hash] request parameters
+  # ==== Return
+  # * camelized params
+  def camelize_params(params)
+    camelized = {}
+    params.each { |k,v| camelized.merge!(k.to_s.camelize(:lower).to_sym => v) }
+    camelized
+  end
+  
+  
+  ##
+  # Sets the HTTP REST type based on the method being called
+  # 
+  # ==== Parameters
+  # * [required, ymbol] the HTTP method to use, may be :delete, :get, :post or :put
+  # * [Object] the uri object to create the request for
+  # * [Object] the request object to be used to operate on the resource
+  #
+  # ==== Return
+  # * Valid HTTP verb instance
+  def set_request_type(method, uri)
+    case method
+    when :delete
+      Net::HTTP::Delete.new(uri)
+    when :get
+      Net::HTTP::Get.new(uri)
+    when :post
+      Net::HTTP::Post.new(uri)
+    when :put
+      Net::HTTP::Put.new(uri)
+    end
+  end
+
+  private
+  
+  ##
+  # Creates (one once) a HTTP client to the Tropo provisioning endpoint
+  #
+  # ==== Return
+  # * Net::HTTP instance
+  def http
+    @http ||= (
+      uri = URI.parse(base_uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
+      http
+    )
+  end
+  
+  ##
+  # Send a request to the Tropo provisioning API
+  #
+  # ==== Parameters
+  # * [required, Symbol] http_request Net::HTTPRequest child
+  # * [required, Hash] params used to create the request
+  #   * [String] :resource the resource to call on the base URL
+  #   * [Hash] :body the details to use when posting, putting or deleting an object, converts into the appropriate JSON
+  #
+  # ==== Return
+  # * [Hash] the result of the request
+  # * [TropoError]
+  #   if it can not connect to the API server or if the response.code is not 200 
+  def request(http_request, params = {})
+    params[:body] and params[:body] = camelize_params(params[:body])
+    
+    uri = params[:resource].nil? ? "" : params[:resource]
+
+    unless http_request.is_a?(Net::HTTPRequest)
+      raise TropoError.new("Invalid request type #{http_request}")
+    end
+    
+    http_request.initialize_http_header(headers)
+    http_request.basic_auth username, password
+    http_request.body = ActiveSupport::JSON.encode params[:body] if params[:body]
+    
+    begin
+      response = http.request(http_request)
+    rescue => e
+      raise TropoError.new, "Unable to connect to the Provisioning API server - #{e.to_s}"
+    end
+
+    response.code.eql?('200') or raise TropoError.new(response.code), "#{response.code}: #{response.message} - #{response.body}"
+    
+    result = ActiveSupport::JSON.decode response.body
+    if result.instance_of? Array
+      self.class.hashie_array(result)
+    else
+      Hashie::Mash.new(result)
+    end    
+  end
+
+  class << self
+    ##
+    # Converts the hashes inside the array to Hashie::Mash objects
+    #
+    # ==== Parameters
+    # * [required, Array] array to be Hashied
+    #
+    # ==== Return
+    # * [Array] array that is now Hashied
+    def hashie_array(array)
+      hashied_array = []
+      array.each do |ele|
+        hashied_array << Hashie::Mash.new(ele)
+      end
+      hashied_array
+    end
+  end
+  
+end