Merge pull request #16 from messagebird/add-ci

Add CI

Author: Artur Khabibullin

.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 2.5.1
+- 2.0.0
+- 1.9.3
+- jruby
+matrix:
+  allow_failures:
+  - rvm: jruby
+install: gem install rspec
+script: rake spec

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

Rakefile

@@ -1,4 +1,9 @@
 require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+end
 
 namespace :gem do
   desc 'Build the messagebird API gem'

lib/messagebird/client.rb

@@ -5,6 +5,7 @@
 require 'messagebird/balance'
 require 'messagebird/error'
 require 'messagebird/hlr'
+require 'messagebird/http_client'
 require 'messagebird/verify'
 require 'messagebird/message'
 require 'messagebird/voicemessage'
@@ -19,42 +20,19 @@ def initialize(errors)
     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)
+      json = JSON.parse(response_body)
 
       # If the request returned errors, create Error objects and raise.
       if json.has_key?('errors')

lib/messagebird/http_client.rb

@@ -0,0 +1,71 @@
+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
+
+      # Construct the HTTP GET or POST request.
+      case method
+      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}"
+
+      # 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)
+
+      assert_valid_response_code(response.code.to_i)
+      assert_json_response_type(response['Content-Type']) unless check_json
+
+      response.body
+    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

messagebird-rest.gemspec

@@ -18,4 +18,6 @@ Gem::Specification.new do |s|
 
   s.files        = Dir.glob("lib/**/*") + %w(LICENSE README.md)
   s.require_path = 'lib'
+
+  s.add_development_dependency 'rspec', '~> 3.8'
 end

spec/balance_spec.rb

@@ -0,0 +1,19 @@
+describe 'Balance' do
+
+  it 'reads' do
+
+    http_client = double(MessageBird::HttpClient)
+    client = MessageBird::Client.new('', http_client)
+
+    expect(http_client)
+      .to receive(:request)
+      .with(:get, 'balance', {})
+      .and_return('{"payment":"prepaid","type":"credits","amount":12.34}')
+
+    balance = client.balance
+
+    expect(balance.payment).to eq 'prepaid'
+
+  end
+
+end

spec/error_spec.rb

@@ -0,0 +1,15 @@
+describe 'Error' do
+
+  it 'raises returned errors' do
+
+    http_client = double(MessageBird::HttpClient)
+    client = MessageBird::Client.new('', http_client)
+
+    expect(http_client)
+      .to receive(:request)
+      .and_return('{"errors":[{"code": 2,"description": "Request not allowed (incorrect access_key)","parameter": "access_key"}]}')
+
+    expect{ client.message('some-id') }.to raise_error(MessageBird::ErrorException)
+  end
+
+end

spec/hlr_spec.rb

@@ -0,0 +1,33 @@
+describe 'HLR' do
+
+  it 'views an existing' do
+
+    http_client = double(MessageBird::HttpClient)
+    client = MessageBird::Client.new('', http_client)
+
+    expect(http_client)
+      .to receive(:request)
+      .with(:get, 'hlr/hlr-id', {})
+      .and_return('{"id":"hlr-id","href":"https://rest.messagebird.com/hlr/hlr-id","msisdn":31612345678,"network":20406,"reference":"MyReference","status": "sent","createdDatetime": "2015-01-04T13:14:08+00:00","statusDatetime": "2015-01-04T13:14:09+00:00"}')
+
+    hlr = client.hlr('hlr-id')
+
+    expect(hlr.id).to eq 'hlr-id'
+
+  end
+
+  it 'requests a HLR' do
+
+    http_client = double(MessageBird::HttpClient)
+    client = MessageBird::Client.new('', http_client)
+
+    expect(http_client)
+      .to receive(:request)
+      .with(:post, 'hlr', {:msisdn => 31612345678, :reference => 'MyReference'})
+      .and_return('{}')
+
+    client.hlr_create(31612345678, 'MyReference')
+
+  end
+
+end