messagebird-rest 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4726ce8ee0e2583a41d1f73a7e6866dda139fb14
-  data.tar.gz: 484cd5e20ed84a89ea58e969289e58daa2d02bdd
+  metadata.gz: ed916adf077ac2e3a03631e2d97fad4a6c9e9c97
+  data.tar.gz: 01aab619642825c19ef2b939a284c138e28542b2
 SHA512:
-  metadata.gz: 79a490c8dd3d3af74ff5ab0bb45209982f35dae182fc6b83cb90177e5b75a60afd36c56bb4285f0affbc1fff15cc7eacf0542e88a1fe742fc88c5a39eee11985
-  data.tar.gz: 6869c83755659c52549eee08b411076a42ed4c469d7ba1b8016f1b3b1668e681db46d8439ac32c2fcb32054207db9a51cdbf76d57c76ddf3d352af121c6ef26b
+  metadata.gz: bfc589631d306c6cdfa0464ed2da03f88c4a7c88846ed0038e48dd20ab8e5e4ddae03a2bdd34c7371e4ce21f3b72b4c0798d43dfcd43f3d359e8e22ec5c85ac8
+  data.tar.gz: 799b7b82c6f6f8839986bdedba3abd47984f6a809b388f6713744b2e2c102a6503ff9cdd02e3baca98832117eaf116fbffa32fddaeea57de02d75c26a2b8a471

data/README.md

@@ -2,6 +2,8 @@ MessageBird's REST API for Ruby
 ===============================
 This repository contains the open source Ruby client for MessageBird's REST API. Documentation can be found at: https://developers.messagebird.com/
 
+[![Build Status](https://travis-ci.org/messagebird/ruby-rest-api.svg?branch=master)](https://travis-ci.org/messagebird/ruby-rest-api)
+
 Requirements
 ------------
 - [Sign up](https://dashboard.messagebird.com/app/en/sign-up) for a free MessageBird account

data/lib/messagebird.rb

@@ -2,14 +2,18 @@ libdir = File.dirname(__FILE__)
 $:.unshift(libdir) unless $:.include?(libdir)
 
 module MessageBird
-  CLIENT_VERSION = '1.3.3'
+  CLIENT_VERSION = '1.4.0'
   ENDPOINT       = 'https://rest.messagebird.com'
 end
 
 require 'messagebird/balance'
 require 'messagebird/client'
+require 'messagebird/contact'
 require 'messagebird/error'
+require 'messagebird/group_reference'
 require 'messagebird/hlr'
+require 'messagebird/http_client'
+require 'messagebird/message_reference'
 require 'messagebird/verify'
 require 'messagebird/message'
 require 'messagebird/voicemessage'

data/lib/messagebird/client.rb

@@ -3,12 +3,16 @@ require 'net/https'
 require 'uri'
 
 require 'messagebird/balance'
+require 'messagebird/contact'
 require 'messagebird/error'
+require 'messagebird/group'
 require 'messagebird/hlr'
-require 'messagebird/verify'
+require 'messagebird/http_client'
+require 'messagebird/list'
+require 'messagebird/lookup'
 require 'messagebird/message'
+require 'messagebird/verify'
 require 'messagebird/voicemessage'
-require 'messagebird/lookup'
 
 module MessageBird
   class ErrorException < StandardError
@@ -19,42 +23,21 @@ module MessageBird
     end
   end
 
-  class InvalidPhoneNumberException < TypeError; end
-
   class Client
+
     attr_reader :access_key
+    attr_reader :http_client
 
-    def initialize(access_key = nil)
+    def initialize(access_key = nil, http_client = nil)
       @access_key = access_key || ENV['MESSAGEBIRD_ACCESS_KEY']
+      @http_client = http_client || HttpClient.new(@access_key)
     end
 
     def request(method, path, params={})
-      uri = URI.join(ENDPOINT, '/', path)
-
-      # Set up the HTTP object.
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl     = true
-
-      # Construct the HTTP GET or POST request.
-      request = Net::HTTP::Get.new(uri.request_uri)  if method == :get
-      request = Net::HTTP::Post.new(uri.request_uri) if method == :post
-      request['Accept']        = 'application/json'
-      request['Authorization'] = "AccessKey #{@access_key}"
-      request['User-Agent']    = "MessageBird/ApiClient/#{CLIENT_VERSION} Ruby/#{RUBY_VERSION}"
-
-      # If present, add the HTTP POST parameters.
-      request.set_form_data(params) if method == :post && !params.empty?
-
-      # Execute the request and fetch the response.
-      response = http.request(request)
-
-      # Parse the HTTP response.
-      case response.code.to_i
-      when 200, 201, 204, 401, 404, 405, 422
-        json = JSON.parse(response.body)
-      else
-        raise InvalidPhoneNumberException, 'Unknown response from server'
-      end
+      response_body = @http_client.request(method, path, params)
+      return if response_body.empty?
+
+      json = JSON.parse(response_body)
 
       # If the request returned errors, create Error objects and raise.
       if json.has_key?('errors')
@@ -156,5 +139,74 @@ module MessageBird
       HLR.new(request(:get, "lookup/#{phoneNumber}/hlr", params))
     end
 
+    def contact_create(phoneNumber, params={})
+      Contact.new(request(
+                      :post,
+                      'contacts',
+                      params.merge({ :msisdn => phoneNumber.to_s })))
+    end
+
+    def contact(id)
+      Contact.new(request(:get, "contacts/#{id}"))
+    end
+
+    def contact_delete(id)
+      request(:delete, "contacts/#{id}")
+    end
+
+    def contact_update(id, params={})
+      request(:patch, "contacts/#{id}", params)
+    end
+
+    def contact_list(limit = 0, offset = 0)
+      List.new(Contact, request(:get, "contacts?limit=#{limit}&offset=#{offset}"))
+    end
+
+    def group(id)
+      Group.new(request(:get, "groups/#{id}"))
+    end
+
+    def group_create(name)
+      Group.new(request(:post, 'groups', { :name => name }))
+    end
+
+    def group_delete(id)
+      request(:delete, "groups/#{id}")
+    end
+
+    def group_list(limit = 0, offset = 0)
+      List.new(Group, request(:get, "groups?limit=#{limit}&offset=#{offset}"))
+    end
+
+    def group_update(id, name)
+      request(:patch, "groups/#{id}", { :name => name })
+    end
+
+    def group_add_contacts(group_id, contact_ids)
+      # We expect an array, but we can handle a string ID as well...
+      contact_ids = [contact_ids] if contact_ids.is_a? String
+
+      query = add_contacts_query(contact_ids)
+
+      request(:get, "groups/#{group_id}?#{query}")
+    end
+
+    def group_delete_contact(group_id, contact_id)
+      request(:delete, "groups/#{group_id}/contacts/#{contact_id}")
+    end
+
+    private # Applies to every method below this line
+
+    def add_contacts_query(contact_ids)
+      # add_contacts_query gets a query string to add contacts to a group.
+      # We're using the alternative "/foo?_method=PUT&key=value" format to send
+      # the contact IDs as GET params. Sending these in the request body would
+      # require a painful workaround, as the client sends request bodies as
+      # JSON by default. See also:
+      # https://developers.messagebird.com/docs/alternatives.
+
+      '_method=PUT&' + contact_ids.map { |id| "ids[]=#{id}" }.join('&')
+    end
+
   end
 end

data/lib/messagebird/contact.rb

@@ -0,0 +1,31 @@
+require 'messagebird/base'
+require 'messagebird/custom_details'
+require 'messagebird/group_reference'
+require 'messagebird/message_reference'
+
+module MessageBird
+  class Contact < MessageBird::Base
+    attr_accessor :id, :href, :msisdn, :firstName, :lastName, :customDetails,
+                  :groups, :messages, :createdDatetime, :updatedDatetime
+
+    def customDetails=(value)
+      @customDetails = MessageBird::CustomDetails.new(value)
+    end
+
+    def groups=(value)
+      @groups = MessageBird::GroupReference.new(value)
+    end
+
+    def messages=(value)
+      @messages = MessageBird::MessageReference.new(value)
+    end
+
+    def createdDatetime=(value)
+      @createdDatetime = value_to_time(value)
+    end
+
+    def updatedDatetime=(value)
+      @updatedDatetime = value_to_time(value)
+    end
+  end
+end

data/lib/messagebird/contact_reference.rb

@@ -0,0 +1,7 @@
+require 'messagebird/base'
+
+module MessageBird
+  class ContactReference < MessageBird::Base
+    attr_accessor :href, :totalCount
+  end
+end

data/lib/messagebird/custom_details.rb

@@ -0,0 +1,8 @@
+require 'messagebird/base'
+
+module MessageBird
+  class CustomDetails < MessageBird::Base
+    # CustomDetails holds free-input fields for the Contact object.
+    attr_accessor :custom1, :custom2, :custom3, :custom4
+  end
+end

data/lib/messagebird/group.rb

@@ -0,0 +1,21 @@
+require 'messagebird/base'
+require 'messagebird/contact_reference'
+
+module MessageBird
+  class Group < MessageBird::Base
+    attr_accessor :id, :href, :name, :contacts, :createdDatetime,
+                  :updatedDatetime
+
+    def contacts=(value)
+      @contacts = MessageBird::ContactReference.new(value)
+    end
+
+    def createdDatetime=(value)
+      @createdDatetime = value_to_time(value)
+    end
+
+    def updatedDatetime=(value)
+      @updatedDatetime = value_to_time(value)
+    end
+  end
+end

data/lib/messagebird/group_reference.rb

@@ -0,0 +1,7 @@
+require 'messagebird/base'
+
+module MessageBird
+  class GroupReference < MessageBird::Base
+    attr_accessor :href, :totalCount
+  end
+end

data/lib/messagebird/http_client.rb

@@ -0,0 +1,78 @@
+require 'net/https'
+require 'uri'
+
+module MessageBird
+
+  class InvalidPhoneNumberException < TypeError; end
+  class InvalidResponseException < StandardError; end
+  class MethodNotAllowedException < ArgumentError; end
+
+  class HttpClient
+
+    attr_reader :access_key
+
+    def initialize(access_key)
+      @access_key = access_key
+    end
+
+    def request(method, path, params={}, check_json=true)
+      uri = URI.join(ENDPOINT, '/', path)
+
+      # Set up the HTTP object.
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl     = true
+
+      request = prepare_request(method, uri, params)
+
+      # Execute the request and fetch the response.
+      response = http.request(request)
+
+      assert_valid_response_code(response.code.to_i)
+      assert_json_response_type(response['Content-Type']) unless check_json
+
+      response.body
+    end
+
+    def prepare_request(method, uri, params={})
+      # Construct the HTTP request.
+      case method
+      when :delete
+        request = Net::HTTP::Delete.new(uri.request_uri)
+      when :get
+        request = Net::HTTP::Get.new(uri.request_uri)
+      when :post
+        request = Net::HTTP::Post.new(uri.request_uri)
+      else
+        raise MethodNotAllowedException
+      end
+
+      request['Accept']        = 'application/json'
+      request['Authorization'] = "AccessKey #{@access_key}"
+      request['User-Agent']    = "MessageBird/ApiClient/#{CLIENT_VERSION} Ruby/#{RUBY_VERSION}"
+
+      request.set_form_data(params) if method == :post && !params.empty?
+
+      request
+    end
+
+    # Throw an exception if the response code is not one we expect from the
+    # MessageBird API.
+    def assert_valid_response_code(code)
+      # InvalidPhoneNumberException does not make a lot of sense here, but it's
+      # needed to maintain backwards compatibility. See issue:
+      # https://github.com/messagebird/ruby-rest-api/issues/17
+      expected_codes = [200, 201, 204, 401, 404, 405, 422]
+      raise InvalidPhoneNumberException, 'Unknown response from server' unless expected_codes.include? code
+    end
+
+    # Throw an exception if the response's content type is not JSON. This only
+    # checks the header: it doesn't inspect the actual body.
+    def assert_json_response_type(content_type)
+      # Check whether the header starts with application/json and don't check
+      # for equality: some API's may append the charset to this header.
+      raise InvalidResponseException, 'Response is not JSON' unless content_type.start_with? 'application/json'
+    end
+
+  end
+
+end

data/lib/messagebird/list.rb

@@ -0,0 +1,23 @@
+require 'messagebird/base'
+
+class List < MessageBird::Base
+
+  attr_accessor :offset, :limit, :count, :totalCount, :links, :items
+
+  # type will be used to create objects for the items, e.g.
+  # List.new(Contact, {}).
+  def initialize(type, json)
+    @type = type
+
+    super(json)
+  end
+
+  def items=(value)
+    @items = value.map { |i| @type.new i }
+  end
+
+  def [](index)
+    @items[index]
+  end
+
+end

data/lib/messagebird/message_reference.rb

@@ -0,0 +1,7 @@
+require 'messagebird/base'
+
+module MessageBird
+  class MessageReference < MessageBird::Base
+    attr_accessor :href, :totalCount
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: messagebird-rest
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Maurice Nonnekes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
-dependencies: []
+date: 2018-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
 description: A simple REST API for MessageBird in Ruby
 email: maurice@messagebird.com
 executables: []
@@ -22,10 +36,18 @@ files:
 - lib/messagebird/balance.rb
 - lib/messagebird/base.rb
 - lib/messagebird/client.rb
+- lib/messagebird/contact.rb
+- lib/messagebird/contact_reference.rb
+- lib/messagebird/custom_details.rb
 - lib/messagebird/error.rb
+- lib/messagebird/group.rb
+- lib/messagebird/group_reference.rb
 - lib/messagebird/hlr.rb
+- lib/messagebird/http_client.rb
+- lib/messagebird/list.rb
 - lib/messagebird/lookup.rb
 - lib/messagebird/message.rb
+- lib/messagebird/message_reference.rb
 - lib/messagebird/recipient.rb
 - lib/messagebird/verify.rb
 - lib/messagebird/voicemessage.rb
@@ -49,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: MessageBird's REST API