elk 0.0.13 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9d07160f26139ffd604d4d542016dfe0911d1a3
-  data.tar.gz: a0b60c90d7064577049183ef23c1df315210ab3f
+  metadata.gz: e3184044f09e7d64a7822c28eaa6e3de56978fc9
+  data.tar.gz: db5a2368596d235da746132e3dae9e03dd56adf2
 SHA512:
-  metadata.gz: f23acab93fb2c7007d71ca1b9dedf74496f620c597f9660b2acdb04b00d5a90de2b454dad58719c0e5711f30b52a4dfcea44e952654ce2b45ed5d1482b03c6d8
-  data.tar.gz: 7de8a02ad30e5df2034a445bc6deff74a786cd43a203e86eecb94a06f35aa28fbd83a3968f07e4642f85837056deed5f02bb983b98033f2b0c7f4f318560012c
+  metadata.gz: d0ced3eef3b56b1225c8c1d92acf8a8a6f428f5105aa2e4a33e666a37c0db058d0bb0fc4348eea2d28232d4960944563aa1bc028ce1bb4e51f8c0cb60bdb4620
+  data.tar.gz: eeeec30f922cc461df8d750621b6c34a62097286848e7477bbef10e490e5af5cedad303355984529971a008a0fb866e72488eaa550da379deec663c4c7ca38c7

data/README.MD

@@ -1,12 +1,14 @@
 # Elk - 46elks API-client
 
+[![Build Status](https://travis-ci.org/jage/elk.svg?branch=master)](https://travis-ci.org/jage/elk)
+[![Code Climate](https://codeclimate.com/github/jage/elk/badges/gpa.svg)](https://codeclimate.com/github/jage/elk)
+
 Ruby client for 46elks "Voice, SMS & MMS" service. http://46elks.com/
 At the moment the API only supports sending SMS messages.
 
 ## Requirements
 
-This gem is only supported on Ruby 1.9 and 2.0.
-
+* Modern Ruby: >= 1.9
 * API account at 46elks.com
 
 ## Install
@@ -21,7 +23,11 @@ The source for Elk is available on Github:
 
     https://github.com/jage/elk
 
-elk uses rspec and webmock for testing, do a `bundle install` for all the development requirements.
+Elk uses rspec and webmock for testing, do a `bundle install` for all the development requirements.
+
+Test specs with:
+
+    bundle exec rake spec
 
 ## Usage
 
@@ -32,12 +38,32 @@ elk can be used to allocate a phone numbers, manage the numbers and send/recieve
 First thing when using elk is to set the authentication parameters
 
 ```Ruby
-require 'elk'
+require "elk"
 
 Elk.configure do |config|
-  config.username = 'USERNAME'
-  config.password = 'PASSWORD'
+  config.username = "USERNAME"
+  config.password = "PASSWORD"
+end
+```
+
+It is possible to avoid the singleton configuration:
+
+```Ruby
+require "elk"
+
+client = Elk::Client.new
+client.configure do |config|
+  config.username = "USERNAME"
+  config.password = "PASSWORD"
 end
+
+# Then pass client to the class methods
+numbers = Elk::Number.all(client: client)
+# => [#<Elk::Number ...>, #<Elk::Number ...>]
+
+
+Elk::SMS.send(client: client, from: "MyService", to: "+46704508449", message: "Your order #171 has now been sent!")
+# => #<Elk::SMS:0x0000010179d7e8 @client=... @from="MyService", @to="+46704508449", @message="Your order #171 has now been sent!", @message_id="sdc39a7926d37159b6985283e32f43251", @created_at=2011-07-17 16:21:13 +0200, @loaded_at=2011-07-17 16:21:13 +0200>
 ```
 
 ### Numbers
@@ -45,7 +71,7 @@ end
 To be able to send and recieve messages, a number is needed. Several numbers can be allocated.
 
 ```Ruby
-number = Elk::Number.allocate(:sms_url => 'http://myservice.se/callback/newsms.php', :country => 'se')
+number = Elk::Number.allocate(sms_url: "http://myservice.se/callback/newsms.php", country: "se")
 # => #<Elk::Number:0x0000010282aa70 @country="se", @sms_url="http://myservice.se/callback/newsms.php", @status="yes", @number_id="n03e7db70cc06c1ff85e09a2b3f86dd62", @number="+46766861034", @capabilities=[:sms], @loaded_at=2011-07-17 15:23:55 +0200>
 ```
 
@@ -59,7 +85,7 @@ numbers = Elk::Number.all
 Change number settings
 
 ```Ruby
-number.sms_url = 'http://myservice.se/callback/newsms.php'
+number.sms_url = "http://myservice.se/callback/newsms.php"
 number.save
 # => true
 ```
@@ -79,7 +105,7 @@ number.status
 Send SMS. Messages can be sent from one of the allocated numbers or an arbitrary alphanumeric string of at most 11 characters.
 
 ```Ruby
-Elk::SMS.send(:from => 'MyService', :to => '+46704508449', :message => 'Your order #171 has now been sent!')
+Elk::SMS.send(from: "MyService", to: "+46704508449", message: "Your order #171 has now been sent!")
 # => #<Elk::SMS:0x0000010179d7e8 @from="MyService", @to="+46704508449", @message="Your order #171 has now been sent!", @message_id="sdc39a7926d37159b6985283e32f43251", @created_at=2011-07-17 16:21:13 +0200, @loaded_at=2011-07-17 16:21:13 +0200>
 ```
 
@@ -87,8 +113,8 @@ Receiving SMS does not require Elk, but should be of interest anyway.
 Example with Sinatra:
 
 ```Ruby
-post '/receive' do
-  if request.params['message'] == 'Hello'
+post "/receive" do
+  if request.params["message"] == "Hello"
     # Sends a return SMS with message "world!"
     "world!"
   end
@@ -104,4 +130,4 @@ Elk::SMS.all
 
 ## Copyright
 
-Copyright (c) 2011 Johan Eckerström. See LICENSE for details.
+Copyright (c) 2011 Johan Eckerström. See [MIT-LICENSE](MIT-LICENSE) for details.

data/lib/elk.rb

@@ -1,93 +1,49 @@
-# External
-require 'multi_json'
-require 'open-uri'
-require 'rest_client'
-require 'time'
+require "forwardable"
 
 # Base module
 # Used for to configure username and password through Elk.configure
 module Elk
-  # Base domain for 46elks API
-  BASE_DOMAIN = 'api.46elks.com'
-  # API version supported
-  API_VERSION = 'a1'
-
-  # When the authentication can't be done
-  class AuthError < RuntimeError; end
-  # Raised when the API server isn't working
-  class ServerError < RuntimeError; end
-  # Generic exception when 46elks API gives a response Elk can't parse
-  class BadResponse < RuntimeError; end
-  # Generic exception when Elk calls 46elk API the wrong way
-  class BadRequest < RuntimeError; end
-  # Raised when required paremeters are omitted
-  class MissingParameter < RuntimeError; end
-
   class << self
-    # API Username from 46elks.com
-    attr_accessor :username
-    # API Password from 46elks.com
-    attr_accessor :password
-    # Defaults to Elk::BASE_DOMAIN, but can be overriden for testing
-    attr_accessor :base_domain
+    extend Forwardable
+
+    # Delegate methods to client
+    delegated_methods = [
+      :username,
+      :username=,
+      :password,
+      :password=,
+      :base_domain,
+      :base_url,
+      :get,
+      :post,
+      :execute,
+    ]
+
+    delegated_methods.each do |method|
+      def_delegator :client, method
+    end
 
     # Set up authentication credentials, has to be done before using Elk::Number and Elk::SMS
     #
     #   Elk.configure do |config|
-    #     config.username = 'USERNAME'
-    #     config.password = 'PASSWORD
+    #     config.username = "USERNAME"
+    #     config.password = "PASSWORD"
     #   end
     def configure
-      yield self
-    end
-
-    # Base URL used for calling 46elks API
-    def base_url
-      if not username or not password
-        raise AuthError, "API username and password required"
-      end
-
-      "https://#{username}:#{password}@#{(base_domain || BASE_DOMAIN)}/#{API_VERSION}"
-    end
-
-    # Wrapper for Elk.execute(:get)
-    def get(path, parameters = {})
-      execute(:get, path, parameters)
-    end
-
-    # Wrapper for Elk::execute(:post)
-    def post(path, parameters = {})
-      execute(:post, path, parameters)
-    end
-
-    # Wrapper around RestClient::RestClient.execute
-    #
-    # * Sets accept header to json
-    # * Handles some exceptions
-    #
-    def execute(method, path, parameters, headers={:accept => :json}, &block)
-      payload = {}.merge(parameters)
-      url = base_url + path
-      RestClient::Request.execute(:method => method, :url => url, :payload => payload, :headers => headers, &block)
-    rescue RestClient::Unauthorized
-      raise AuthError, "Authentication failed"
-    rescue RestClient::InternalServerError
-      raise ServerError, "Server error"
-    rescue RestClient::Forbidden => e
-      raise BadRequest, e.http_body
+      yield client
     end
 
-    # Wrapper around MultiJson.load, symbolize names
-    def parse_json(body)
-      MultiJson.load(body, :symbolize_keys => true)
-    rescue MultiJson::DecodeError
-      raise BadResponse, "Can't parse JSON"
+    # Not thread safe
+    def client
+      @client ||= Client.new
     end
   end
 end
 
 # Internal
-require 'elk/util'
-require 'elk/version'
-require 'elk/number'
-require 'elk/sms'
+require_relative "elk/util"
+require_relative "elk/error"
+require_relative "elk/version"
+require_relative "elk/client"
+require_relative "elk/number"
+require_relative "elk/sms"

data/lib/elk/client.rb

@@ -0,0 +1,77 @@
+require "rest_client"
+
+module Elk
+  class Client
+    # Base domain for 46elks API
+    BASE_DOMAIN = "api.46elks.com"
+    # API version supported
+    API_VERSION = "a1"
+
+    # API Username from 46elks.com
+    attr_accessor :username
+    # API Password from 46elks.com
+    attr_accessor :password
+    # Used to overrid Elk::BASE_DOMAIN (in tests)
+    attr_accessor :base_domain
+
+    def initialize(parameters = {})
+      @username = parameters[:username]
+      @password = parameters[:password]
+    end
+
+    # Set authentication credentials
+    #
+    #   client = Elk::Client.new
+    #   client.configure do |config|
+    #     config.username = "USERNAME"
+    #     config.password = "PASSWORD"
+    #   end
+    def configure
+      yield self
+    end
+
+    # Base URL used for calling 46elks API
+    def base_url
+      unless username && password
+        raise AuthError, "API username and password required"
+      end
+
+      "https://#{username}:#{password}@#{(base_domain || BASE_DOMAIN)}/#{API_VERSION}"
+    end
+
+    # Wrapper for Elk.execute(:get)
+    def get(path, parameters = {})
+      execute(:get, path, parameters)
+    end
+
+    # Wrapper for Elk::execute(:post)
+    def post(path, parameters = {})
+      execute(:post, path, parameters)
+    end
+
+    # Wrapper around RestClient::RestClient.execute
+    #
+    # * Sets accept header to json
+    # * Handles some exceptions
+    #
+    def execute(method, path, parameters, headers = { accept: :json }, &block)
+      payload = {}.merge(parameters)
+      url = base_url + path
+
+      request_arguments = {
+        method:  method,
+        url:     url,
+        payload: payload,
+        headers: headers
+      }
+
+      RestClient::Request.execute(request_arguments, &block)
+    rescue RestClient::Unauthorized
+      raise AuthError, "Authentication failed"
+    rescue RestClient::InternalServerError
+      raise ServerError, "Server error"
+    rescue RestClient::Forbidden => e
+      raise BadRequest, e.http_body
+    end
+  end
+end

data/lib/elk/error.rb

@@ -0,0 +1,16 @@
+module Elk
+  # When the authentication can't be done
+  class AuthError < RuntimeError; end
+
+  # Raised when the API server isn't working
+  class ServerError < RuntimeError; end
+
+  # Generic exception when 46elks API gives a response Elk can't parse
+  class BadResponse < RuntimeError; end
+
+  # Generic exception when Elk calls 46elk API the wrong way
+  class BadRequest < RuntimeError; end
+
+  # Raised when required paremeters are omitted
+  class MissingParameter < RuntimeError; end
+end

data/lib/elk/number.rb

@@ -1,7 +1,9 @@
+require "time"
+
 module Elk
   # Allocate and manage numbers used for SMS/MMS/Voice
   class Number
-    attr_reader :number_id, :number, :capabilities, :loaded_at #:nodoc:
+    attr_reader :number_id, :number, :capabilities, :loaded_at, :client #:nodoc:
     attr_accessor :country, :sms_url, :voice_start_url #:nodoc:
 
     def initialize(parameters) #:nodoc:
@@ -15,16 +17,17 @@ module Elk
       @status       = parameters[:active]
       @number_id    = parameters[:id]
       @number       = parameters[:number]
-      @capabilities = parameters[:capabilities].collect {|c| c.to_sym }
+      @capabilities = Array(parameters[:capabilities]).map(&:to_sym)
       @loaded_at    = Time.now
+      @client       = parameters.fetch(:client) { Elk.client }
     end
 
     # Status of a number, if it's :active or :deallocated
     def status
       case @status
-      when 'yes'
+      when "yes"
         :active
-      when 'no'
+      when "no"
         :deallocated
       else
         nil
@@ -33,26 +36,30 @@ module Elk
 
     # Reloads a number from the API server
     def reload
-      response = Elk.get("/Numbers/#{self.number_id}")
-      self.set_paramaters(Elk.parse_json(response.body))
+      response = @client.get("/Numbers/#{self.number_id}")
+      self.set_paramaters(Elk::Util.parse_json(response.body))
       response.code == 200
     end
 
     # Updates or allocates a number
     def save
-      attributes = {:sms_url => self.sms_url, :voice_start => self.voice_start_url}
+      attributes = {
+        sms_url:     self.sms_url,
+        voice_start: self.voice_start_url
+      }
+
       # If new URL, send country, otherwise not
-      if !self.number_id
+      unless self.number_id
         attributes[:country] = self.country
       end
-      response = Elk.post("/Numbers/#{self.number_id}", attributes)
+      response = @client.post("/Numbers/#{self.number_id}", attributes)
       response.code == 200
     end
 
     # Deallocates a number, once allocated, a number cannot be used again, ever!
     def deallocate!
-      response = Elk.post("/Numbers/#{self.number_id}", {:active => 'no'})
-      self.set_paramaters(Elk.parse_json(response.body))
+      response = @client.post("/Numbers/#{self.number_id}", { active: "no" })
+      self.set_paramaters(Elk::Util.parse_json(response.body))
       response.code == 200
     end
 
@@ -62,19 +69,36 @@ module Elk
       # Allocates a phone number
       #
       # * Required parameters: :country
-      # * Optional parameters: :sms_url, :voice_start_url
+      # * Optional parameters: :sms_url, :voice_start_url, :client
       def allocate(parameters)
         verify_parameters(parameters, [:country])
-        response = Elk.post('/Numbers', parameters)
-        self.new(Elk.parse_json(response.body))
+
+        client = parameters.fetch(:client) { Elk.client }
+
+        allowed_arguments = [:country, :sms_url, :voice_start_url]
+        arguments = parameters.dup.select do |key, _|
+          allowed_arguments.include?(key)
+        end
+
+        response = client.post('/Numbers', arguments)
+        self.new(Elk::Util.parse_json(response.body))
       end
 
       # Returns all Elk::Numbers, regardless of status (allocated/deallocated)
-      def all
-        response = Elk.get('/Numbers')
+      #
+      # Optional parameters
+      #
+      # * :client - Elk::Client instance
+      #
+      def all(parameters = {})
+        client = parameters.fetch(:client) { Elk.client }
+
+        response = client.get('/Numbers')
 
-        Elk.parse_json(response.body)[:data].collect do |n|
-          self.new(n)
+        numbers = Elk::Util.parse_json(response.body).fetch(:data)
+        numbers.map do |number|
+          number[:client] = client
+          self.new(number)
         end
       end
     end