elk 0.0.13 → 0.5.0

data/spec/spec.opts

@@ -1,4 +1,4 @@
 --colour
 --format progress
 --loadby mtime
---reverse
+--reverse

data/spec/spec_helper.rb

@@ -1,5 +1,3 @@
-require 'rubygems'
-require 'bundler/setup'
 require 'rspec'
 require 'webmock/rspec'
 
@@ -16,4 +14,12 @@ def configure_elk
     config.username = 'USERNAME'
     config.password = 'PASSWORD'
   end
-end
+end
+
+def get_headers
+  { "Accept" => "application/json" }
+end
+
+def post_headers
+  { "Accept" => "application/json", "Content-Type" => "application/x-www-form-urlencoded" }
+end

data/spec/unit/client_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+require "elk"
+
+describe Elk::Client do
+  it { is_expected.to respond_to(:configure) }
+  it { is_expected.to respond_to(:base_url) }
+  it { is_expected.to respond_to(:base_domain) }
+  it { is_expected.to respond_to(:username) }
+  it { is_expected.to respond_to(:username=) }
+  it { is_expected.to respond_to(:password) }
+  it { is_expected.to respond_to(:password=) }
+
+  let(:username) { "username" }
+  let(:password) { "password" }
+
+  it "should accept username and password" do
+    client = Elk::Client.new(username: username, password: password)
+    expect(client.username).to eq(username)
+    expect(client.password).to eq(password)
+  end
+
+  describe ".base_url" do
+    context "detect missing username and/or password" do
+      context "when nothing is configured" do
+        specify do
+          subject.configure do |config|
+            config.username = nil
+            config.password = nil
+          end
+
+          expect { subject.base_url }.to raise_error(Elk::AuthError)
+        end
+      end
+
+      context "when username is missing" do
+        specify do
+          subject.configure do |config|
+            config.username = nil
+            config.password = "PASSWORD"
+          end
+
+          expect { subject.base_url }.to raise_error(Elk::AuthError)
+        end
+      end
+
+      context "when password is missing" do
+        specify do
+          subject.configure do |config|
+            config.username = "USERNAME"
+            config.password = nil
+          end
+
+          expect { subject.base_url }.to raise_error(Elk::AuthError)
+        end
+      end
+
+      context "when all is configured" do
+        specify do
+          subject.configure do |config|
+            config.username = "USERNAME"
+            config.password = "PASSWORD"
+          end
+
+          expect { subject.base_url }.not_to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/unit/elk_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+require "elk"
+
+describe Elk do
+
+  subject { Elk }
+
+  it { is_expected.to respond_to(:client) }
+  it { is_expected.to respond_to(:configure) }
+  it { is_expected.to respond_to(:base_url) }
+  it { is_expected.to respond_to(:base_domain) }
+  it { is_expected.to respond_to(:username) }
+  it { is_expected.to respond_to(:username=) }
+  it { is_expected.to respond_to(:password) }
+  it { is_expected.to respond_to(:password=) }
+
+  describe ".client" do
+    it "should reuse the same client object" do
+      expect(Elk.client.object_id).to eq(Elk.client.object_id)
+    end
+  end
+
+  describe ".base_url" do
+    context "detect missing username and/or password" do
+      context "when nothing is configured" do
+        specify do
+          subject.configure do |config|
+            config.username = nil
+            config.password = nil
+          end
+
+          expect { subject.base_url }.to raise_error(Elk::AuthError)
+        end
+      end
+
+      context "when username is missing" do
+        specify do
+          subject.configure do |config|
+            config.username = nil
+            config.password = "PASSWORD"
+          end
+
+          expect { subject.base_url }.to raise_error(Elk::AuthError)
+        end
+      end
+
+      context "when password is missing" do
+        specify do
+          subject.configure do |config|
+            config.username = "USERNAME"
+            config.password = nil
+          end
+
+          expect { subject.base_url }.to raise_error(Elk::AuthError)
+        end
+      end
+
+      context "when all is configured" do
+        specify do
+          subject.configure do |config|
+            config.username = "USERNAME"
+            config.password = "PASSWORD"
+          end
+
+          expect { subject.base_url }.not_to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/unit/number_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+require "elk"
+require "json"
+
+describe Elk::Number do
+  subject(:number) { described_class.new({}) }
+
+  let(:client) { instance_double(Elk::Client) }
+
+  describe "#new" do
+    context "when passing a client" do
+      subject(:number) { described_class.new(client: client) }
+
+      it "should use the passed in client" do
+        expect(number.client).to eq(client)
+      end
+    end
+
+    context "without passing a client" do
+      it "should instantiate a client" do
+        expect(number.client).to be_an(Elk::Client)
+      end
+    end
+  end
+
+  describe "#status" do
+    subject(:status) { described_class.new(active: active).status }
+
+    context "with an active number" do
+      let(:active) { "yes" }
+
+      it { is_expected.to eq(:active) }
+    end
+
+    context "with an deallocated number" do
+      let(:active) { "no" }
+
+      it { is_expected.to eq(:deallocated) }
+    end
+
+    context "without any status" do
+      let(:active) { }
+
+      it { is_expected.to eq(nil) }
+    end
+
+    context "with an unknown status" do
+      let(:active) { "bananas" }
+
+      it { is_expected.to eq(nil) }
+    end
+  end
+
+  describe ".allocate" do
+    let(:allocate_response) { double("Response", body: JSON.dump({}) ) }
+
+    context "when passing a client" do
+      it "should use the passed in client" do
+        expect(client).to receive(:post)
+          .with("/Numbers", country: "no") { allocate_response }
+        described_class.allocate(client: client, country: "no")
+      end
+    end
+
+    context "without passing a client" do
+      it "should instantiate a client" do
+        expect_any_instance_of(Elk::Client).to receive(:post)
+          .with("/Numbers", country: "no") { allocate_response }
+        described_class.allocate(country: "no")
+      end
+    end
+  end
+
+  describe ".all" do
+    let(:all_response) { double("Response", body: JSON.dump(data: []) ) }
+
+    context "when passing a client" do
+      it "should use the passed in client" do
+        expect(client).to receive(:get)
+          .with("/Numbers") { all_response }
+        described_class.all(client: client)
+      end
+    end
+
+    context "without passing a client" do
+      it "should instantiate a client" do
+        expect_any_instance_of(Elk::Client).to receive(:get)
+          .with("/Numbers") { all_response }
+        described_class.all
+      end
+    end
+  end
+end

data/spec/unit/sms_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+require "elk"
+require "json"
+
+describe Elk::SMS do
+  subject(:sms) { described_class.new({}) }
+
+  let(:client) { instance_double(Elk::Client) }
+
+  describe "#new" do
+    context "when passing a client" do
+      subject(:sms) { described_class.new(client: client) }
+
+      it "should use the passed in client" do
+        expect(sms.client).to eq(client)
+      end
+    end
+
+    context "without passing a client" do
+      it "should instantiate a client" do
+        expect(sms.client).to be_an(Elk::Client)
+      end
+    end
+  end
+
+  describe ".send" do
+    let(:sms_response) { double("Response", body: JSON.dump({}) ) }
+
+    context "when passing a client" do
+      it "should use the passed in client" do
+        expect(client).to receive(:post)
+          .with("/SMS", from: "", to: "", message: "") { sms_response }
+        described_class.send(client: client, from: "", to: "", message: "")
+      end
+    end
+
+    context "without passing a client" do
+      it "should instantiate a client" do
+        expect_any_instance_of(Elk::Client).to receive(:post)
+          .with("/SMS", from: "", to: "", message: "") { sms_response }
+        described_class.send(from: "", to: "", message: "")
+      end
+    end
+
+  end
+
+  describe ".all" do
+    let(:all_response) { double("Response", body: JSON.dump(data: []) ) }
+
+    context "when passing a client" do
+      it "should use the passed in client" do
+        expect(client).to receive(:get)
+          .with("/SMS") { all_response }
+        described_class.all(client: client)
+      end
+    end
+
+    context "without passing a client" do
+      it "should instantiate a client" do
+        expect_any_instance_of(Elk::Client).to receive(:get)
+          .with("/SMS") { all_response }
+        described_class.all
+      end
+    end
+  end
+end

data/spec/unit/utils_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+require "elk"
+
+describe Elk::Util do
+  describe "#verify_parameters" do
+    let(:parameters) { { from: "mom", to: "god" } }
+
+    context "with all required parameters" do
+      let(:required_parameters) { [:from, :to] }
+
+      it "should not raise any exceptions" do
+        extend Elk::Util
+        expect {
+          verify_parameters(parameters, required_parameters)
+        }.to_not raise_error
+      end
+    end
+
+    context "with a missing required parameter" do
+      let(:required_parameters) { [:from, :to, :message] }
+
+      it "should raise missing parameter exception" do
+        extend Elk::Util
+        expect {
+          verify_parameters(parameters, required_parameters)
+        }.to raise_error(Elk::MissingParameter)
+      end
+    end
+  end
+
+  describe ".parse_json" do
+    subject { Elk::Util }
+
+    context "with empty object body" do
+      let(:body) { "{}" }
+
+      it "should return empty hash" do
+        expect(subject.parse_json(body)).to eq({})
+      end
+    end
+
+    context "with garbage json" do
+      let(:body) { fixture("bad_response_body.txt").read }
+
+      it "should raise bad response exception" do
+        expect { subject.parse_json(body) }.to raise_error(Elk::BadResponse)
+      end
+    end
+  end
+end

metadata

@@ -1,83 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: elk
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.5.0
 platform: ruby
 authors:
-- Johan Eckerstroem
+- Johan Eckerström
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2016-02-13 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.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Elk can be used to allocate a phone numbers, manage the numbers and send
@@ -89,16 +75,15 @@ extra_rdoc_files:
 - README.MD
 - MIT-LICENSE
 files:
-- README.MD
 - MIT-LICENSE
+- README.MD
+- lib/elk.rb
+- lib/elk/client.rb
+- lib/elk/error.rb
 - lib/elk/number.rb
 - lib/elk/sms.rb
 - lib/elk/util.rb
 - lib/elk/version.rb
-- lib/elk.rb
-- spec/elk/number_spec.rb
-- spec/elk/sms_spec.rb
-- spec/elk_spec.rb
 - spec/fixtures/allocates_a_number.txt
 - spec/fixtures/auth_error.txt
 - spec/fixtures/bad_response_body.txt
@@ -114,8 +99,15 @@ files:
 - spec/fixtures/server_error.txt
 - spec/fixtures/sms_history.txt
 - spec/fixtures/updates_a_number.txt
+- spec/integration/number_spec.rb
+- spec/integration/sms_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/unit/client_spec.rb
+- spec/unit/elk_spec.rb
+- spec/unit/number_spec.rb
+- spec/unit/sms_spec.rb
+- spec/unit/utils_spec.rb
 homepage: https://github.com/jage/elk
 licenses:
 - MIT
@@ -126,18 +118,18 @@ 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:
 - API account at 46elks.com
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Client library for 46elks SMS/MMS/Voice service.