maestrano 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46d72cf16b89994faf979aeb8054a4e428fde7ab
+  data.tar.gz: 54d8aeb2955cbf58c1e06ccadb572060bdfaf86c
+SHA512:
+  metadata.gz: d35c0dcf93d7d231154141bedab869c0f24cd38c3304e3cfc57c0265932f7dc8ebaeb33fa59dfee69126f490b067950aeafd6a6b9beda2fd08695b81a20c91cb
+  data.tar.gz: c649204b85ed1ebab729d783f6516d6c7940a83d3ef4e4c7abc208e1cf2d0fbab0fdab72fa847ce1fde289dd7c5792661d04a8a75d236e5cc4ff641d29ebf35d

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    maestrano (0.1.0)
+      json (~> 1.8)
+      mime-types (~> 1.25)
+      nokogiri (>= 1.5.0)
+      rest-client (~> 1.4)
+      uuid (~> 2.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    json (1.8.1)
+    macaddr (1.7.1)
+      systemu (~> 2.6.2)
+    metaclass (0.0.4)
+    mime-types (1.25.1)
+    mini_portile (0.6.0)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    rake (10.3.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    shoulda (2.11.3)
+    systemu (2.6.4)
+    test-unit (2.5.5)
+    timecop (0.6.0)
+    uuid (2.3.7)
+      macaddr (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  maestrano!
+  mocha (~> 0.13.2)
+  rake
+  shoulda (~> 2.11.0)
+  test-unit
+  timecop (<= 0.6.0)

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2014 Maestrano Pty. Ltd.
+
+The MIT License (MIT)
+
+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,4 @@
+maestrano-ruby
+==============
+
+Maestrano Ruby Bindings

data/Rakefile

@@ -0,0 +1,32 @@
+task :default => [:test]
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+Rake::TestTask.new(:saml) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/maestrano/saml/**/*_test.rb'
+  test.verbose = true
+end
+
+Rake::TestTask.new(:api) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/maestrano/api/**/*_test.rb'
+  test.verbose = true
+end
+
+Rake::TestTask.new(:sso) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/maestrano/sso{_test.rb,/**/*_test.rb}'
+  test.verbose = true
+end
+
+Rake::TestTask.new(:xmlsec) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/maestrano/xml_security/**/*_test.rb'
+  test.verbose = true
+end

data/bin/maestrano-console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+libs <<  " -I #{File.dirname(__FILE__) + '/../lib'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/maestrano'}"
+puts ">> Loading Maestrano console"
+puts ">>"
+exec "#{irb} #{libs} --simple-prompt"

data/lib/maestrano.rb

@@ -0,0 +1,114 @@
+# libs
+require 'rest_client'
+require 'json'
+
+# Version
+require 'maestrano/version'
+
+# XMLSecurity
+require 'maestrano/xml_security/signed_document'
+
+# SAML
+require 'maestrano/saml/request'
+require 'maestrano/saml/attribute_value'
+require 'maestrano/saml/response'
+require 'maestrano/saml/settings'
+require 'maestrano/saml/validation_error'
+require 'maestrano/saml/metadata'
+
+# SSO
+require 'maestrano/sso'
+require 'maestrano/sso/base_user'
+require 'maestrano/sso/base_group'
+require 'maestrano/sso/session'
+require 'maestrano/sso/user'
+require 'maestrano/sso/group'
+
+# API Errors
+require 'maestrano/api/error/base_error'
+require 'maestrano/api/error/authentication_error'
+require 'maestrano/api/error/connection_error'
+require 'maestrano/api/error/invalid_request_error'
+
+# API Operations
+require 'maestrano/api/operation/base'
+require 'maestrano/api/operation/create'
+require 'maestrano/api/operation/delete'
+require 'maestrano/api/operation/list'
+require 'maestrano/api/operation/update'
+
+# API
+require 'maestrano/api/util'
+require 'maestrano/api/object'
+require 'maestrano/api/list_object'
+require 'maestrano/api/resource'
+
+# API - Account Entities
+require 'maestrano/account/bill'
+
+module Maestrano
+  
+  class << self
+    attr_accessor :config
+  end
+  
+  # Maestrano Configuration block
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+  end
+  
+  # Get configuration parameter value
+  # E.g:
+  # Maestrano.param('api_key')
+  # Maestrano.param(:api_key)
+  def self.param(parameter)
+    self.config.param(parameter)
+  end
+
+  class Configuration
+    attr_accessor :environment, :api_key, :sso_enabled, 
+      :app_host, :sso_app_init_path, :sso_app_consume_path, :user_creation_mode,
+      :verify_ssl_certs, :api_version
+
+    def initialize
+      @environment = 'test'
+      @api_key = nil
+      @sso_enabled = true
+      @app_host = 'http://localhost:3000'
+      @sso_app_init_path = '/maestrano/auth/saml/init'
+      @sso_app_consume_path = '/maestrano/auth/saml/consume'
+      @user_creation_mode = 'virtual'
+      @verify_ssl_certs = false
+      @api_version = nil
+    end
+    
+    # Get configuration parameter value
+    def param(parameter)
+      if self.respond_to?(parameter)
+        self.send(parameter)
+      elsif EVT_CONFIG[@environment.to_sym].has_key?(parameter.to_sym)
+        EVT_CONFIG[@environment.to_sym][parameter.to_sym]
+      else
+        raise ArgumentError, "No such configuration parameter: '#{parameter}'"
+      end
+    end
+    
+    EVT_CONFIG = {
+      test: {
+        api_host: 'http://api-sandbox.maestrano.io',
+        api_base: '/api/v1/',
+        sso_name_id_format: Maestrano::Saml::Settings::NAMEID_PERSISTENT,
+        sso_x509_fingerprint: '01:06:15:89:25:7d:78:12:28:a6:69:c7:de:63:ed:74:21:f9:f5:36',
+        sso_x509_certificate: "-----BEGIN CERTIFICATE-----\nMIIDezCCAuSgAwIBAgIJAOehBr+YIrhjMA0GCSqGSIb3DQEBBQUAMIGGMQswCQYD\nVQQGEwJBVTEMMAoGA1UECBMDTlNXMQ8wDQYDVQQHEwZTeWRuZXkxGjAYBgNVBAoT\nEU1hZXN0cmFubyBQdHkgTHRkMRYwFAYDVQQDEw1tYWVzdHJhbm8uY29tMSQwIgYJ\nKoZIhvcNAQkBFhVzdXBwb3J0QG1hZXN0cmFuby5jb20wHhcNMTQwMTA0MDUyMjM5\nWhcNMzMxMjMwMDUyMjM5WjCBhjELMAkGA1UEBhMCQVUxDDAKBgNVBAgTA05TVzEP\nMA0GA1UEBxMGU3lkbmV5MRowGAYDVQQKExFNYWVzdHJhbm8gUHR5IEx0ZDEWMBQG\nA1UEAxMNbWFlc3RyYW5vLmNvbTEkMCIGCSqGSIb3DQEJARYVc3VwcG9ydEBtYWVz\ndHJhbm8uY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDVkIqo5t5Paflu\nP2zbSbzxn29n6HxKnTcsubycLBEs0jkTkdG7seF1LPqnXl8jFM9NGPiBFkiaR15I\n5w482IW6mC7s8T2CbZEL3qqQEAzztEPnxQg0twswyIZWNyuHYzf9fw0AnohBhGu2\n28EZWaezzT2F333FOVGSsTn1+u6tFwIDAQABo4HuMIHrMB0GA1UdDgQWBBSvrNxo\neHDm9nhKnkdpe0lZjYD1GzCBuwYDVR0jBIGzMIGwgBSvrNxoeHDm9nhKnkdpe0lZ\njYD1G6GBjKSBiTCBhjELMAkGA1UEBhMCQVUxDDAKBgNVBAgTA05TVzEPMA0GA1UE\nBxMGU3lkbmV5MRowGAYDVQQKExFNYWVzdHJhbm8gUHR5IEx0ZDEWMBQGA1UEAxMN\nbWFlc3RyYW5vLmNvbTEkMCIGCSqGSIb3DQEJARYVc3VwcG9ydEBtYWVzdHJhbm8u\nY29tggkA56EGv5giuGMwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOBgQCc\nMPgV0CpumKRMulOeZwdpnyLQI/NTr3VVHhDDxxCzcB0zlZ2xyDACGnIG2cQJJxfc\n2GcsFnb0BMw48K6TEhAaV92Q7bt1/TYRvprvhxUNMX2N8PHaYELFG2nWfQ4vqxES\nRkjkjqy+H7vir/MOF3rlFjiv5twAbDKYHXDT7v1YCg==\n-----END CERTIFICATE-----"
+      },
+      production: {
+        api_host: 'https://maestrano.com',
+        api_base: '/api/v1/',
+        sso_name_id_format: Maestrano::Saml::Settings::NAMEID_PERSISTENT,
+        sso_x509_fingerprint: '2f:57:71:e4:40:19:57:37:a6:2c:f0:c5:82:52:2f:2e:41:b7:9d:7e',
+        sso_x509_certificate: "-----BEGIN CERTIFICATE-----\nMIIDezCCAuSgAwIBAgIJAPFpcH2rW0pyMA0GCSqGSIb3DQEBBQUAMIGGMQswCQYD\nVQQGEwJBVTEMMAoGA1UECBMDTlNXMQ8wDQYDVQQHEwZTeWRuZXkxGjAYBgNVBAoT\nEU1hZXN0cmFubyBQdHkgTHRkMRYwFAYDVQQDEw1tYWVzdHJhbm8uY29tMSQwIgYJ\nKoZIhvcNAQkBFhVzdXBwb3J0QG1hZXN0cmFuby5jb20wHhcNMTQwMTA0MDUyNDEw\nWhcNMzMxMjMwMDUyNDEwWjCBhjELMAkGA1UEBhMCQVUxDDAKBgNVBAgTA05TVzEP\nMA0GA1UEBxMGU3lkbmV5MRowGAYDVQQKExFNYWVzdHJhbm8gUHR5IEx0ZDEWMBQG\nA1UEAxMNbWFlc3RyYW5vLmNvbTEkMCIGCSqGSIb3DQEJARYVc3VwcG9ydEBtYWVz\ndHJhbm8uY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD3feNNn2xfEz5/\nQvkBIu2keh9NNhobpre8U4r1qC7h7OeInTldmxGL4cLHw4ZAqKbJVrlFWqNevM5V\nZBkDe4mjuVkK6rYK1ZK7eVk59BicRksVKRmdhXbANk/C5sESUsQv1wLZyrF5Iq8m\na9Oy4oYrIsEF2uHzCouTKM5n+O4DkwIDAQABo4HuMIHrMB0GA1UdDgQWBBSd/X0L\n/Pq+ZkHvItMtLnxMCAMdhjCBuwYDVR0jBIGzMIGwgBSd/X0L/Pq+ZkHvItMtLnxM\nCAMdhqGBjKSBiTCBhjELMAkGA1UEBhMCQVUxDDAKBgNVBAgTA05TVzEPMA0GA1UE\nBxMGU3lkbmV5MRowGAYDVQQKExFNYWVzdHJhbm8gUHR5IEx0ZDEWMBQGA1UEAxMN\nbWFlc3RyYW5vLmNvbTEkMCIGCSqGSIb3DQEJARYVc3VwcG9ydEBtYWVzdHJhbm8u\nY29tggkA8WlwfatbSnIwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOBgQDE\nhe/18oRh8EqIhOl0bPk6BG49AkjhZZezrRJkCFp4dZxaBjwZTddwo8O5KHwkFGdy\nyLiPV326dtvXoKa9RFJvoJiSTQLEn5mO1NzWYnBMLtrDWojOe6Ltvn3x0HVo/iHh\nJShjAn6ZYX43Tjl1YXDd1H9O+7/VgEWAQQ32v8p5lA==\n-----END CERTIFICATE-----"
+      }
+    }
+  end
+end

data/lib/maestrano/account/bill.rb

@@ -0,0 +1,14 @@
+module Maestrano
+  module Account
+    class Bill < Maestrano::API::Resource
+      include Maestrano::API::Operation::List
+      include Maestrano::API::Operation::Create
+
+      def cancel
+        response, api_key = Maestrano::API::Operation::Base.request(:delete, url, @api_key)
+        refresh_from(response, api_key)
+        self
+      end
+    end
+  end
+end

data/lib/maestrano/api/error/authentication_error.rb

@@ -0,0 +1,8 @@
+module Maestrano
+  module API
+    module Error
+      class AuthenticationError < Maestrano::API::Error::BaseError
+      end
+    end
+  end
+end

data/lib/maestrano/api/error/base_error.rb

@@ -0,0 +1,24 @@
+module Maestrano
+  module API
+    module Error
+      class BaseError < StandardError
+        attr_reader :message
+        attr_reader :http_status
+        attr_reader :http_body
+        attr_reader :json_body
+
+        def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+          @message = message
+          @http_status = http_status
+          @http_body = http_body
+          @json_body = json_body
+        end
+
+        def to_s
+          status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+          "#{status_string}#{@message}"
+        end
+      end
+    end
+  end
+end

data/lib/maestrano/api/error/connection_error.rb

@@ -0,0 +1,8 @@
+module Maestrano
+  module API
+    module Error
+      class ConnectionError < Maestrano::API::Error::BaseError
+      end
+    end
+  end
+end

data/lib/maestrano/api/error/invalid_request_error.rb

@@ -0,0 +1,14 @@
+module Maestrano
+  module API
+    module Error
+      class InvalidRequestError < Maestrano::API::Error::BaseError
+        attr_accessor :param
+
+        def initialize(message, param, http_status=nil, http_body=nil, json_body=nil)
+          super(message, http_status, http_body, json_body)
+          @param = param
+        end
+      end
+    end
+  end
+end

data/lib/maestrano/api/list_object.rb

@@ -0,0 +1,37 @@
+module Maestrano
+  module API
+    class ListObject < Maestrano::API::Object
+
+      def [](k)
+        case k
+        when String, Symbol
+          super
+        else
+          raise ArgumentError.new("You tried to access the #{k.inspect} index, but ListObject types only support String keys. (HINT: List calls return an object with a 'data' (which is the data array). You likely want to call #data[#{k.inspect}])")
+        end
+      end
+
+      def each(&blk)
+        self.data.each(&blk)
+      end
+
+      def retrieve(id, api_key=nil)
+        api_key ||= @api_key
+        response, api_key = Maestrano::API::Operation::Base.request(:get,"#{url}/#{CGI.escape(id)}", api_key)
+        Util.convert_to_maestrano_object(response, api_key)
+      end
+
+      def create(params={}, api_key=nil)
+        api_key ||= @api_key
+        response, api_key = Maestrano::API::Operation::Base.request(:post, url, api_key, params)
+        Util.convert_to_maestrano_object(response, api_key)
+      end
+
+      def all(params={}, api_key=nil)
+        api_key ||= @api_key
+        response, api_key = Maestrano::API::Operation::Base.request(:get, url, api_key, params)
+        Util.convert_to_maestrano_object(response, api_key)
+      end
+    end
+  end
+end

data/lib/maestrano/api/object.rb

@@ -0,0 +1,187 @@
+module Maestrano
+  module API
+    class Object
+      include Enumerable
+
+      attr_accessor :api_key
+      @@permanent_attributes = Set.new([:api_key, :id])
+
+      # The default :id method is deprecated and isn't useful to us
+      if method_defined?(:id)
+        undef :id
+      end
+
+      def initialize(id=nil, api_key=nil)
+        # parameter overloading!
+        if id.kind_of?(Hash)
+          @retrieve_options = id.dup
+          @retrieve_options.delete(:id)
+          id = id[:id]
+        else
+          @retrieve_options = {}
+        end
+
+        @api_key = api_key
+        @values = {}
+        # This really belongs in API::Resource, but not putting it there allows us
+        # to have a unified inspect method
+        @unsaved_values = Set.new
+        @transient_values = Set.new
+        @values[:id] = id if id
+      end
+
+      def self.construct_from(values, api_key=nil)
+        obj = self.new(values[:id], api_key)
+        obj.refresh_from(values, api_key)
+        obj
+      end
+
+      def to_s(*args)
+        JSON.pretty_generate(@values)
+      end
+
+      def inspect()
+        id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
+        "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
+      end
+
+      def refresh_from(values, api_key, partial=false)
+        @api_key = api_key
+
+        @previous_metadata = values[:metadata]
+        removed = partial ? Set.new : Set.new(@values.keys - values.keys)
+        added = Set.new(values.keys - @values.keys)
+        # Wipe old state before setting new.
+
+        instance_eval do
+          remove_accessors(removed)
+          add_accessors(added)
+        end
+        removed.each do |k|
+          @values.delete(k)
+          @transient_values.add(k)
+          @unsaved_values.delete(k)
+        end
+        values.each do |k, v|
+          @values[k] = Util.convert_to_maestrano_object(v, api_key)
+          @transient_values.delete(k)
+          @unsaved_values.delete(k)
+        end
+      end
+
+      def [](k)
+        @values[k.to_sym]
+      end
+
+      def []=(k, v)
+        send(:"#{k}=", v)
+      end
+
+      def keys
+        @values.keys
+      end
+
+      def values
+        @values.values
+      end
+
+      def to_json(*a)
+        JSON.generate(@values)
+      end
+
+      def as_json(*a)
+        @values.as_json(*a)
+      end
+
+      def to_hash
+        @values
+      end
+
+      def each(&blk)
+        @values.each(&blk)
+      end
+
+      def _dump(level)
+        Marshal.dump([@values, @api_key])
+      end
+
+      def self._load(args)
+        values, api_key = Marshal.load(args)
+        construct_from(values, api_key)
+      end
+
+      if RUBY_VERSION < '1.9.2'
+        def respond_to?(symbol)
+          @values.has_key?(symbol) || super
+        end
+      end
+
+      protected
+
+      def metaclass
+        class << self; self; end
+      end
+
+      def remove_accessors(keys)
+        metaclass.instance_eval do
+          keys.each do |k|
+            next if @@permanent_attributes.include?(k)
+            k_eq = :"#{k}="
+            remove_method(k) if method_defined?(k)
+            remove_method(k_eq) if method_defined?(k_eq)
+          end
+        end
+      end
+
+      def add_accessors(keys)
+        metaclass.instance_eval do
+          keys.each do |k|
+            next if @@permanent_attributes.include?(k)
+            k_eq = :"#{k}="
+            define_method(k) { @values[k] }
+            define_method(k_eq) do |v|
+              if v == ""
+                raise ArgumentError.new(
+                  "You cannot set #{k} to an empty string." +
+                  "We interpret empty strings as nil in requests." +
+                  "You may set #{self}.#{k} = nil to delete the property.")
+              end
+              @values[k] = v
+              @unsaved_values.add(k)
+            end
+          end
+        end
+      end
+
+      def method_missing(name, *args)
+        # TODO: only allow setting in updateable classes.
+        if name.to_s.end_with?('=')
+          attr = name.to_s[0...-1].to_sym
+          add_accessors([attr])
+          begin
+            mth = method(name)
+          rescue NameError
+            raise NoMethodError.new("Cannot set #{attr} on this object. HINT: you can't set: #{@@permanent_attributes.to_a.join(', ')}")
+          end
+          return mth.call(args[0])
+        else
+          return @values[name] if @values.has_key?(name)
+        end
+
+        begin
+          super
+        rescue NoMethodError => e
+          if @transient_values.include?(name)
+            raise NoMethodError.new(e.message + ".  HINT: The '#{name}' attribute was set in the past, however.  It was then wiped when refreshing the object with the result returned by Maestrano's API, probably as a result of a save().  The attributes currently available on this object are: #{@values.keys.join(', ')}")
+          else
+            raise
+          end
+        end
+      end
+
+      def respond_to_missing?(symbol, include_private = false)
+        @values.has_key?(symbol) || super
+      end
+    end
+  end
+end