3scale_api 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0760d1fb028c4855c5477a58cc1d4f3ba1bddff3
+  data.tar.gz: 41562a512efbbd707b4406177eca447204d0a3cb
+SHA512:
+  metadata.gz: 72cdb9d77ed42d42ba8b92884386da152281c4c092354cdc1d390ffdad32ca74077634d5c4773d6bc5e4ce7179d42e1bbc57ca4cf223bac9d34d80372050013b
+  data.tar.gz: 6cf1433e7e57660c616c29e9771c839f0c406036e7cecb9f305c493117e201b3cc2f79943ae18263b1f4df76953202304e6f7688af797d1b5f4b73d264cb60e5

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+/.idea/*

data/.ruby-gemset

@@ -0,0 +1 @@
+threescale_api

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.1

data/3scale_api.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require '3scale_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "3scale_api"
+  spec.version       = Threescale::VERSION
+  spec.authors       = ["Robbie Holmes"]
+  spec.email         = ["robbiethegeek@gmail.com"]
+  spec.summary       = %q{3Scale API client gem.}
+  spec.description   = %q{This gem is to be used to interact with 3Scale's API.}
+  spec.homepage      = "https://github.com/IDTLabs/3scale_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.test_files = Dir.glob("test/**/*.rb")
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Robbie Holmes
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# 3scale - API
+
+[![Join the chat at https://gitter.im/IDTLabs/threescale_api](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/IDTLabs/threescale_api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Gem Version](https://badge.fury.io/rb/threescale_api.svg)](http://badge.fury.io/rb/threescale_api)
+
+This gem will allow developers to interact with 3Scale's APIs.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem '3scale_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install 3scale_api
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/threescale_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

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

@@ -0,0 +1,86 @@
+require 'faraday'
+require 'securerandom'
+require 'nokogiri'
+
+module Threescale
+  class API
+    attr_accessor :provider_key, :url, :path, :conn
+    def initialize(provider_key = nil, debug = false)
+      if ENV['THREESCALE_URL']
+        @url = ENV['THREESCALE_URL']
+      else
+        raise Error, "Please set your 3 Scale URL as an environmental variable THREESCALE_URL"
+      end
+      if not provider_key
+        if ENV['THREESCALE_PROVIDER_KEY']
+          provider_key = ENV['THREESCALE_PROVIDER_KEY']
+        end
+        raise Error, "You must provide a 3 Scale provider key" if not provider_key
+      end
+      @provider_key = provider_key
+      @conn = Faraday.new(url = @url) do | faraday|
+        faraday.request :url_encoded
+        faraday.response :logger
+        faraday.adapter Faraday.default_adapter
+      end
+    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, }
+      p response.status
+      return [] if response.status != 200
+      xml = Nokogiri::XML(response.body)
+      nodes = xml.xpath('keys/key')
+      nodes.css('value').map do |key|
+        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, }
+      return [] if response.status != 200
+      xml = Nokogiri::XML(response.body)
+      applications = xml.xpath('applications/application')
+      applications.each do |application|
+        keys = application.xpath("//keys/key").map do |key|
+          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})
+      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

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

data/lib/3scale_api.rb

@@ -0,0 +1,3 @@
+require "3scale_api/3scale/api"
+module Threescale
+end

data/spec/3scale_api_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe "3scaleApi" do
+  before(:all) 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
+  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
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+# our gem
+require '3scale_api'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: 3scale_api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Robbie Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-02 00:00:00.000000000 Z
+dependencies: []
+description: This gem is to be used to interact with 3Scale's API.
+email:
+- robbiethegeek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- 3scale_api.gemspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/3scale_api.rb
+- lib/3scale_api/3scale/api.rb
+- lib/3scale_api/version.rb
+- spec/3scale_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/IDTLabs/3scale_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: 3Scale API client gem.
+test_files: []