twilio-ruby 4.2.0 → 4.2.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDNmMGMwNWY2OTAyNTlmNmJmMzYxOTI4ZWVjYzdjYWRiNGI1Yzc3NQ==
-  data.tar.gz: !binary |-
-    YTQ5YjQzNDBlYjIyYTNlMzgzNGVkODg1MThiY2FiN2NiNTBkZGU0NQ==
+SHA1:
+  metadata.gz: af489771a6143eed6bab64834224d33424173807
+  data.tar.gz: 9ace9554caa5f9726e8391aaa554dbd9ccfcd2a3
 SHA512:
-  metadata.gz: !binary |-
-    NjNlOTQ1NmFjMzdmNDI0MDhkMzA4MTkwOTI1NzEyNDkzY2FiMGQ3ZDBkMzll
-    OWZmMzc2ZjQ2YWM3MzI2Y2JkMTNkNGIwMzUwZTBmOTQ1NzVhNzQ3MDJhODQ3
-    MDQ0NThjNmU4NjdiYjhkMGEzMjBkMDM0MjJlMjcxZTU5NzU5NDM=
-  data.tar.gz: !binary |-
-    M2QzOWIxMjliYzRjNTQ0YTYyMjU4NTU1MDFiYjc2NTI1NTllMGNmODNmOTZm
-    YTMxYzQ3YWQ4OTg5YTBhNDAxMjU3MjJmOWRhZDZlNjU3ODllMzQyMDRmYTRm
-    NGZjYTM1MGQ3Yzg5MDRlZThlNzY5MmQ4N2M3NDZlZDcwMGJiMDg=
+  metadata.gz: 73a48780f30ca69167c4de6f48acea63366718ddb6d54908e11147075edb864497f7972b2de58393e50c28cf77076c8754fc28b34ebcd7a45264aaea3b962d25
+  data.tar.gz: 885802c111f183d73945f7fd8ddc99f75834017890e4a304e26296a791e9b508396771bf77bbabcf2588a8e5aa1e07b3f46d9094c77e7e9e265acfa008e9a12e

data/CHANGES.md

@@ -1,6 +1,15 @@
 twilio-ruby changelog
 =====================
 
+Version 4.2.1
+-------------
+
+Release June 19, 2015
+
+- Allow passing URL parameters through when getting statistics for TaskRouter objects
+- URI encode phone number lookups
+- Adds documentation for lookups
+
 Version 4.2.0
 -------------
 

data/README.md

@@ -11,7 +11,7 @@ A module for using the Twilio REST API and generating valid [TwiML](http://www.t
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 4.1.0'
+gem 'twilio-ruby', '~> 4.2.1'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
@@ -147,6 +147,30 @@ capability.allow_client_incoming 'andrew'
 There is a slightly more detailed document in the [Capability][capability]
 section of the wiki.
 
+## Lookup Phone Number information
+
+You can look up details on phone numbers with the Lookups API.
+
+```ruby
+require 'twilio-ruby'
+
+# put your own credentials here
+account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+
+# set up a client to talk to the Twilio REST API
+@lookups_client = Twilio::REST::LookupsClient.new account_sid, auth_token
+
+# lookup a number
+number = @lookups_client.phone_numbers.get('+14159341234')
+
+# investigate the number
+number.national_format
+# => "(415) 934-1234"
+number.country_code
+# => "US"
+```
+
 ## Getting Started With TwiML
 
 TwiML support is based on the [Builder][builder] library. You can construct a
@@ -201,7 +225,7 @@ If you've instead found a bug in the library or would like new features added, g
 ## More Information
 
 There are more detailed examples in the included [examples][examples]
-directory. Also for thoose upgrading, the [upgrade guide][upgrade] is available in the [twilio-ruby github wiki][wiki].
+directory. Also for those upgrading, the [upgrade guide][upgrade] is available in the [twilio-ruby github wiki][wiki].
 
 [capability]: https://github.com/twilio/twilio-ruby/wiki/Capability
 [builder]: http://builder.rubyforge.org/

data/docs/index.rst

@@ -71,6 +71,16 @@ state.
     usage/taskrouter-tokens
 
 
+Lookups
+-------
+
+Query the Lookups API to get information about phone numbers and their carriers.
+
+.. toctree::
+    :maxdepth: 1
+
+    usage/lookups
+
 TwiML
 ---------
 

data/docs/usage/lookups.rst

@@ -0,0 +1,62 @@
+===========
+Lookups API
+===========
+
+Lookups allows you to systematically ascertain information about phone numbers. With Lookups, you can identify local-friendly number formats, reduce the likelihood of undelivered messages and protect yourself from fraud.
+
+For more information see the `Lookups API <https://www.twilio.com/docs/api/rest/lookups>`_ documentation.
+
+Looking up details on a phone number
+------------------------------------
+
+You can look up a phone number with a :class:`Twilio::REST::LookupsClient`. You instantiate the client as you would with any other :class:`Twilio::REST` client
+
+.. code-block:: ruby
+
+    require "twilio-ruby"
+
+    # Find these values at twilio.com/user/account
+    account_sid = "AC123123"
+    auth_token = "secret"
+
+    @lookups_client = Twilio::REST::LookupsClient.new account_sid, auth_token
+
+You can then use the client to lookup a phone number.
+
+.. code-block:: ruby
+
+    response = @lookups_client.phone_numbers.get("+12316851234")
+    response.country_code
+    # => "US"
+    response.phone_number
+    # => "+12316851234"
+    response.national_format
+    # => "(231) 685-1234"
+    response.url
+    # => "https://lookups.twilio.com/v1/PhoneNumbers/+12316851234"
+
+Invalid Phone Numbers
+---------------------
+
+The Lookups API is a REST API that returns data on phone number resources. If you try to lookup a phone number that doesn't exist the API will raise a 404 :class:`Twilio::REST::RequestError`. You should handle this within your code.
+
+.. code-block:: ruby
+
+    response = @lookups_client.phone_numbers.get("+15558675309")
+    begin
+      puts response.phone_number
+    rescue Twilio::REST::RequestError => e
+      raise e unless e.code == 20404 # ensure this is a 404 error
+      puts "Invalid number"
+    end
+
+Carrier Information
+-------------------
+
+The Lookups API can be used to find out more information about the carrier for the phone number. Just pass the type "carrier" to the request.
+
+.. code-block:: ruby
+
+    response = @lookups_client.phone_numbers.get("+12316851234", type: "carrier")
+    response.carrier
+    # => {"mobile_country_code"=>nil, "mobile_network_code"=>nil, "name"=>"Charter Fiberlink, LLC", "type"=>"landline", "error_code"=>nil}

data/lib/twilio-ruby/rest/lookups/phone_numbers.rb

@@ -6,7 +6,7 @@ module Twilio
         include Twilio::REST::Utils
 
         def get(number, query={})
-          full_path = "#{@path}/#{number}"
+          full_path = "#{@path}/#{URI.encode(number)}"
           full_path << "?#{url_encode(twilify(query))}" if !query.empty?
           @instance_class.new full_path, @client
         end

data/lib/twilio-ruby/rest/task_router/statistics.rb

@@ -4,7 +4,7 @@ module Twilio
       module Statistics
         def statistics(args={})
           path = "#{@path}/Statistics"
-          response = @client.get(path, args, true)
+          response = @client.get(path, args)
           statistics_class.new(path, @client, response)
         end
 

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-  VERSION = '4.2.0'
+  VERSION = '4.2.1'
 end

data/spec/rest/lookups/phone_number_spec.rb

@@ -5,4 +5,24 @@ describe Twilio::REST::Lookups::PhoneNumbers do
     client = Twilio::REST::LookupsClient.new 'otherSid', 'otherToken'
     expect(client).to respond_to(:phone_numbers)
   end
+
+  it 'gets phone numbers without special encoding' do
+    number = '+13123131434'
+    client = Twilio::REST::LookupsClient.new 'otherSid', 'otherToken'
+    expect(client).to receive(:get).once
+      .with('/v1/PhoneNumbers/+13123131434')
+      .and_return({ phone_number: number })
+    phone_number = client.phone_numbers.get('+13123131434').phone_number
+    expect(phone_number).to be(number)
+  end
+
+  it 'URI encodes phone number path parameters' do
+    number = '+13123131434'
+    client = Twilio::REST::LookupsClient.new 'otherSid', 'otherToken'
+    expect(client).to receive(:get).once
+      .with('/v1/PhoneNumbers/+1%20312%20313%201434')
+      .and_return({ phone_number: number })
+    phone_number = client.phone_numbers.get('+1 312 313 1434').phone_number
+    expect(phone_number).to be(number)
+  end
 end

data/spec/rest/task_router/statistics_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+class Twilio::REST::TaskRouter::StatisticsTestHarnessStatistics
+  def initialize(*args)
+  end
+end
+
+class StatisticsTestHarness
+  include Twilio::REST::TaskRouter::Statistics
+
+  def initialize(path, client)
+    @path = path
+    @client = client
+  end
+end
+
+describe Twilio::REST::TaskRouter::Statistics do
+  it "creates a new statistics object based on the class" do
+    client = double("Client")
+    allow(client).to receive(:get)
+    harness = StatisticsTestHarness.new("/test/harness", client)
+    expect(harness.statistics).to(
+      be_an_instance_of(Twilio::REST::TaskRouter::StatisticsTestHarnessStatistics)
+    )
+  end
+
+  it "passes parameters to the HTTP request for statistics" do
+    client = Twilio::REST::TaskRouterClient.new 'someSid', 'someAuthToken', 'someWorkspaceSid'
+    allow(Net::HTTP::Get).to receive(:new)
+      .with("/test/harness/Statistics?Minutes=15", Twilio::REST::BaseClient::HTTP_HEADERS)
+      .and_call_original
+    harness = StatisticsTestHarness.new("/test/harness", client)
+    expect(harness.statistics(minutes: 15)).to(
+      be_an_instance_of(Twilio::REST::TaskRouter::StatisticsTestHarnessStatistics)
+    )
+  end
+end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: twilio-ruby
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.2.1
 platform: ruby
 authors:
 - Andrew Benton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 description: A simple library for communicating with the Twilio REST API, building
@@ -76,8 +76,8 @@ extra_rdoc_files:
 - README.md
 - LICENSE.md
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - AUTHORS.md
 - CHANGES.md
 - Gemfile
@@ -112,6 +112,7 @@ files:
 - docs/usage/caller-ids.rst
 - docs/usage/conferences.rst
 - docs/usage/errors.rst
+- docs/usage/lookups.rst
 - docs/usage/messages.rst
 - docs/usage/notifications.rst
 - docs/usage/phone-calls.rst
@@ -234,6 +235,7 @@ files:
 - spec/rest/sms/message_spec.rb
 - spec/rest/sms/messages_spec.rb
 - spec/rest/task_router/reservation_spec.rb
+- spec/rest/task_router/statistics_spec.rb
 - spec/rest/task_router/task_queue_spec.rb
 - spec/rest/token_spec.rb
 - spec/rest/utils_spec.rb
@@ -253,27 +255,27 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --line-numbers
-- --inline-source
-- --title
+- "--line-numbers"
+- "--inline-source"
+- "--title"
 - twilio-ruby
-- --main
+- "--main"
 - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A simple library for communicating with the Twilio REST API, building TwiML,
@@ -298,6 +300,7 @@ test_files:
 - spec/rest/sms/message_spec.rb
 - spec/rest/sms/messages_spec.rb
 - spec/rest/task_router/reservation_spec.rb
+- spec/rest/task_router/statistics_spec.rb
 - spec/rest/task_router/task_queue_spec.rb
 - spec/rest/token_spec.rb
 - spec/rest/utils_spec.rb