RubyGems - 3scale_api - Versions diffs - 1.0.1 → 1.0.2 - Mend

3scale_api 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

checksums.yaml +4 -4
data/Gemfile +6 -6
data/lib/3scale_api/3scale/api.rb +38 -34
data/lib/3scale_api/version.rb +1 -1
data/spec/3scale_api_spec.rb +114 -22
data/spec/spec_helper.rb +5 -4
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0760d1fb028c4855c5477a58cc1d4f3ba1bddff3
-  data.tar.gz: 41562a512efbbd707b4406177eca447204d0a3cb
+  metadata.gz: 2d0223786cde69d7a70a886afb91b6f3c3919659
+  data.tar.gz: 052c5d209b2d50fed163f952cfce07d9b958d193
 SHA512:
-  metadata.gz: 72cdb9d77ed42d42ba8b92884386da152281c4c092354cdc1d390ffdad32ca74077634d5c4773d6bc5e4ce7179d42e1bbc57ca4cf223bac9d34d80372050013b
-  data.tar.gz: 6cf1433e7e57660c616c29e9771c839f0c406036e7cecb9f305c493117e201b3cc2f79943ae18263b1f4df76953202304e6f7688af797d1b5f4b73d264cb60e5
+  metadata.gz: e698537127b7dacd729e4f8e1ea1b59042e6092f0d6dd73e1abf03c9d8d692797ddcc78d1c174b1c3be68e701975b0c5cbd4cf618dc9d6765ec5614f50a9b2d0
+  data.tar.gz: 15003f3b05077cf23fa2a039db8e11a4b56075763042c63363063043f845bc813f1eaceebbae09305e445cdc562d30689d69efcbdcffaef382e141dea7df4bcb

data/Gemfile CHANGED Viewed

@@ -1,11 +1,11 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
-gem 'faraday'
-gem 'json'
-gem 'nokogiri'
+gem "faraday"
+gem "json"
+gem "nokogiri"
 gemspec
 gem "bundler", "~> 1.6"
 gem "rake", "~> 10.0"
 gem "webmock"
-gem "vcr"
-gem 'rspec'
+gem "rspec"
+gem "pry"

data/lib/3scale_api/3scale/api.rb CHANGED Viewed

@@ -5,11 +5,11 @@ require 'nokogiri'
 module Threescale
   class API
     attr_accessor :provider_key, :url, :path, :conn
-    def initialize(provider_key = nil, debug = false)
+    def initialize(provider_key = nil)
       if ENV['THREESCALE_URL']
         @url = ENV['THREESCALE_URL']
       else
-        raise Error, "Please set your 3 Scale URL as an environmental variable THREESCALE_URL"
+        raise ("Please set your 3 Scale URL as an environmental variable THREESCALE_URL")
       end
       if not provider_key
         if ENV['THREESCALE_PROVIDER_KEY']
@@ -25,9 +25,38 @@ module Threescale
       end
     end
+    def create_application(account_id, plan_id, name, description = nil)
+      response = conn.post "/admin/api/accounts/#{account_id}/applications.xml", {
+        :provider_key => @provider_key ,
+        :name => name,
+        :description => description,
+        :plan_id => plan_id}
+      return false if response.status != 201
+      xml = Nokogiri::XML(response.body)
+      result = {
+          :app_id => xml.css("application application_id").text ,
+          :application_id => xml.css("application id").text,
+          :keys => [xml.css("application keys key").text]
+      }
+    end
+    def delete_application_key(account_id, application_id, key)
+      response = @conn.delete "/admin/api/accounts/#{account_id}/applications/#{application_id}/keys/#{key}.xml", {
+      :provider_key => @provider_key }
+      response.status == 200
+    end
+    def generate_application_key(account_id, application_id)
+      new_key = SecureRandom.hex(16)
+      response = conn.post "/admin/api/accounts/#{account_id}/applications/#{application_id}/keys.xml", {
+                                                                                                          :provider_key => @provider_key ,
+                                                                                                          :key => new_key }
+      response.status == 201
+    end
     def get_application_keys(account_id, application_id)
       response = @conn.get "/admin/api/accounts/#{account_id}/applications/#{application_id}/keys.xml", {
-        :provider_key => @provider_key, }
+      :provider_key => @provider_key, }
       p response.status
       return [] if response.status != 200
       xml = Nokogiri::XML(response.body)
@@ -36,6 +65,7 @@ module Threescale
         key.text
       end
     end
     def get_application_list(account_id)
       results = Array.new
       response = @conn.get "/admin/api/accounts/#{account_id}/applications.xml", {:provider_key => @provider_key, }
@@ -47,40 +77,14 @@ module Threescale
           key.text
         end
         results.push(
-            {:keys => keys,
-             :id => application.css('id').text,
-             :name => application.css('name').text,
-             :application_id => application.css('application_id').text,
-             :plan_type => application.css('plan name').text})
+        {:keys => keys,
+        :id => application.css('id').text,
+        :name => application.css('name').text,
+        :application_id => application.css('application_id').text,
+        :plan_type => application.css('plan name').text})
       end
       results
     end
-    def delete_application_key(account_id, application_id, key)
-      response = @conn.delete "/admin/api/accounts/#{account_id}/applications/#{application_id}/keys/#{key}.xml", {
-        :provider_key => @provider_key }
-      response.status == 200
-    end
-    def generate_application_key(account_id, application_id)
-      new_key = SecureRandom.hex(16)
-      response = conn.post "/admin/api/accounts/#{account_id}/applications/#{application_id}/keys.xml", {
-        :provider_key => @provider_key ,
-        :key => new_key }
-      response.status == 201
-    end
-    def create_application(account_id, plan_id, name, description = nil)
-      response = conn.post "/admin/api/accounts/#{account_id}/applications.xml", {
-        :provider_key => @provider_key ,
-        :name => name,
-        :description => description,
-        :plan_id => plan_id}
-      return false if response.status != 201
-      xml = Nokogiri::XML(response.body)
-      result = {
-        :app_id => xml.css("application application_id").text ,
-        :application_id => xml.css("application id").text,
-        :keys => [xml.css("application keys key").text]
-      }
-    end
   end
 end

data/lib/3scale_api/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Threescale
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/3scale_api_spec.rb CHANGED Viewed

@@ -5,28 +5,120 @@ describe "3scaleApi" do
     ENV["THREESCALE_URL"] = nil
     ENV["THREESCALE_PROVIDER_KEY"] = nil
   end
-  it "should raise an error when there is no env variables and you instantiate" do
-    lambda do
-      Threescale::API.new
-    end.should raise_error
+  describe "Instantiate 3scale object" do
+    it "should raise an error when there is no env variables and you instantiate" do
+      lambda do
+        Threescale::API.new
+      end.should raise_error
+    end
+    it "should raise an error when there is no env variables and you instantiate obj" do
+      lambda do
+        ENV["THREESCALE_URL"] = "test-url"
+        Threescale::API.new
+      end.should raise_error
+    end
+    it "should not raise an error when there is one env variables and you instantiate" do
+      lambda do
+        ENV["THREESCALE_URL"] = "test-url"
+        Threescale::API.new "provider-key"
+      end.should_not raise_error
+    end
+    it "should not raise an error when both env variables and you instantiate" do
+      lambda do
+        ENV["THREESCALE_URL"] = "http://test-url"
+        ENV["THREESCALE_PROVIDER_KEY"] = "provider-key"
+        Threescale::API.new
+      end.should_not raise_error
+    end
   end
-  it "should raise an error when there is no env variables and you instantiate obj" do
-    lambda do
-      ENV["THREESCALE_URL"] = "test-url"
-      Threescale::API.new
-    end.should raise_error
-  end
-  it "should not raise an error when there is one env variables and you instantiate" do
-    lambda do
-      ENV["THREESCALE_URL"] = "test-url"
-      Threescale::API.new "provider-key"
-    end.should_not raise_error
-  end
-  it "should not raise an error when both env variables and you instantiate" do
-    lambda do
-      ENV["THREESCALE_URL"] = "test-url"
-      ENV["THREESCALE_PROVIDER_KEY"] = "provider-key"
-      Threescale::API.new
-    end.should_not raise_error
+  describe "API methods" do
+    before(:all) do
+      ENV["THREESCALE_URL"] = "http://test-url.test"
+      @threescale = Threescale::API.new 'provider-key'
+    end
+    describe "get_application_keys" do
+      it "should call /admin/api/accounts/{account_id}/applications/{application_id}/keys.xml" do
+        stub_request(
+          :get,
+          "http://test-url.test/admin/api/accounts/account-id/applications/application-id/keys.xml?provider_key=provider-key").
+            with(
+              :headers => {
+                'Accept'=>'*/*',
+                'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                'User-Agent'=>'Faraday v0.9.1'}).
+            to_return(:status => 200, :body => "", :headers => {})
+        @threescale.get_application_keys 'account-id', 'application-id'
+      end
+    end
+    describe "get_application_list" do
+      it "should call /admin/api/accounts/{account_id}/applications.xml" do
+        stub_request(
+          :get,
+          "http://test-url.test/admin/api/accounts/account-id/applications.xml?provider_key=provider-key").
+            with(
+              :headers => {
+                'Accept'=>'*/*',
+                'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                'User-Agent'=>'Faraday v0.9.1'}).
+            to_return(:status => 200, :body => "", :headers => {})
+        @threescale.get_application_list 'account-id'
+      end
+    end
+    describe "delete_application_key" do
+      it "should call /admin/api/accounts/{account_id}/applications/{application_id}/keys/{key}.xml" do
+        stub_request(
+          :delete,
+          "http://test-url.test/admin/api/accounts/account-id/applications/application-id/keys/key.xml?provider_key=provider-key").
+            with(
+              :headers => {
+                'Accept'=>'*/*',
+                'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                'User-Agent'=>'Faraday v0.9.1'}).
+            to_return(:status => 200, :body => "", :headers => {})
+        @threescale.delete_application_key 'account-id', 'application-id', 'key'
+      end
+    end
+    describe "generate_application_key" do
+      it "should call /admin/api/accounts/{account_id}/applications/{application_id}/keys.xml" do
+        stub_request(
+          :post,
+          "http://test-url.test/admin/api/accounts/account-id/applications/application-id/keys.xml").
+            with(
+              :body => {
+                "key"=>/[0-9a-f]{32}/,
+                "provider_key"=>"provider-key"},
+                 :headers => {
+                   'Accept'=>'*/*',
+                   'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                   'Content-Type'=>'application/x-www-form-urlencoded',
+                   'User-Agent'=>'Faraday v0.9.1'})
+        @threescale.generate_application_key 'account-id', 'application-id'
+      end
+    end
+    describe "create_application" do
+      it "should call /admin/api/accounts/{account_id}/applications.xml" do
+        stub_request(
+          :post,
+          "http://test-url.test/admin/api/accounts/account-id/applications.xml").
+            with(
+              :body => {
+                "description"=>"description",
+                "name"=>"name",
+                "plan_id"=>"plan-id",
+                "provider_key"=>"provider-key"},
+                 :headers => {
+                   'Accept'=>'*/*',
+                   'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                   'Content-Type'=>'application/x-www-form-urlencoded',
+                   'User-Agent'=>'Faraday v0.9.1'}).
+            to_return(:status => 200, :body => "", :headers => {})
+        @threescale.create_application 'account-id', 'plan-id', 'name', 'description'
+      end
+    end
   end
 end

data/spec/spec_helper.rb CHANGED Viewed

@@ -1,8 +1,9 @@
 require 'rubygems'
 require 'bundler/setup'
-# our gem
+require 'webmock/rspec'
+require 'webmock/rspec/matchers'
+require 'webmock/rspec/matchers/request_pattern_matcher'
+require 'webmock/rspec/matchers/webmock_matcher'
 require '3scale_api'
-RSpec.configure do |config|
-end
+WebMock.disable_net_connect!(allow_localhost: true)

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Robbie Holmes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-03 00:00:00.000000000 Z
 dependencies: []
 description: This gem is to be used to interact with 3Scale's API.
 email: