apigee-platform 0.0.2

data/lib/apigee-platform/objects/api.rb

@@ -0,0 +1,11 @@
+module ApigeePlatform::Objects
+  class Api < Base
+    
+    schema do
+      string 'name'
+      string 'description'
+    end
+
+    set_primary_key :name
+  end
+end

data/lib/apigee-platform/objects/apiproduct.rb

@@ -0,0 +1,10 @@
+module ApigeePlatform::Objects
+  class Apiproduct < Base
+    schema do
+      string 'name'
+    end
+
+    set_primary_key :name
+
+  end
+end

data/lib/apigee-platform/objects/app.rb

@@ -0,0 +1,11 @@
+module ApigeePlatform::Objects
+  class App < Base
+
+    schema do
+      string 'name'
+    end
+
+    set_primary_key :appId
+
+  end
+end

data/lib/apigee-platform/objects/base.rb

@@ -0,0 +1,88 @@
+module ApigeePlatform::Objects
+  class Base < ActiveResource::Base
+    include ApigeePlatform::Associations
+
+    def initialize(*args)
+      super(*args)
+      @id = self.attributes[self.class.primary_key]
+      self
+    end
+
+    def custom_attributes
+      @custom_attributes ||= ApigeePlatform::CustomAttributes.new(self)
+    end
+
+    def encode(options={}) 
+      super options.merge(:root => false)
+    end
+
+    def load(*args)
+      super(*args)
+      self.attributes['attributes'].map!{|r| {'name' => r.name, 'value' => r.value}} if self.attributes['attributes']
+
+      self.class.prefix_options.each do |k,v|
+        self.prefix_options[k] = self.attributes[v]
+      end
+      self.onload if self.respond_to?(:onload)
+      self
+    end
+
+    def id 
+      # need that to get correct element_path when update resource object
+      @id ||= self.attributes[self.class.primary_key]
+    end
+
+    class << self    
+      attr_reader :config
+
+      def configure(config)
+        @config = config.symbolize_keys.slice(:user, :password, :organization, :url)
+        @config[:url] ||= 'https://api.enterprise.apigee.com'
+
+        self.site = @config[:url] + '/v1/o/' + @config[:organization]
+        self.user = @config[:user]
+        self.password = @config[:password]
+
+        require 'apigee-platform/objects/api'
+        require 'apigee-platform/objects/apiproduct'
+        require 'apigee-platform/objects/app'
+        require 'apigee-platform/objects/key'
+        require 'apigee-platform/objects/company'
+        require 'apigee-platform/objects/company_app'
+        require 'apigee-platform/objects/company_app_key'
+        require 'apigee-platform/objects/developer'
+        require 'apigee-platform/objects/developer_app'
+        require 'apigee-platform/objects/developer_app_key'
+
+        self
+      end
+
+      def set_prefix_options(options)
+        @prefix_options = options
+      end
+
+      def prefix_options
+        @prefix_options || []
+      end
+
+      def instantiate_record(record, prefix_options = {})
+        return record unless record.is_a?(Hash)
+        super(record, prefix_options)
+      end
+
+      def collection_path(prefix_options = {}, query_options = nil)
+        check_prefix_options(prefix_options)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        "#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
+      end
+
+      def element_path(id, prefix_options = {}, query_options = nil)
+        check_prefix_options(prefix_options)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        "#{prefix(prefix_options)}#{collection_name}/#{URI.parser.escape id.to_s}#{query_string(query_options)}"
+      end
+    end
+
+  end
+
+end

data/lib/apigee-platform/objects/company.rb

@@ -0,0 +1,13 @@
+module ApigeePlatform::Objects
+  class Company < Base
+    
+    schema do
+      string 'name', 'displayName', 'status'
+    end
+
+    set_primary_key :name
+    validates_presence_of :name
+    has_many :apps, :company_name => :name
+
+  end
+end

data/lib/apigee-platform/objects/company_app.rb

@@ -0,0 +1,17 @@
+module ApigeePlatform::Objects
+  class CompanyApp < App    
+    set_primary_key :name
+    set_prefix_options :company_name => :companyName
+
+    self.site = self.site.to_s + "/companies/:company_name"
+    validates_presence_of :name
+
+    belongs_to :company, :key => :companyName
+    has_many :keys, :through => :credentials
+    
+    def self.element_name
+      'app'
+    end
+
+  end
+end

data/lib/apigee-platform/objects/company_app_key.rb

@@ -0,0 +1,7 @@
+module ApigeePlatform::Objects
+  class CompanyAppKey < Key
+    set_prefix_options :company_name => :companyName, :app_name => :name
+    self.site = self.site.to_s + "/companies/:company_name/apps/:app_name"
+    set_primary_key :consumerKey
+  end
+end

data/lib/apigee-platform/objects/developer.rb

@@ -0,0 +1,20 @@
+module ApigeePlatform::Objects
+  class Developer < Base
+
+    schema do
+      string 'name', 'email', 'firstName', 'lastName', 'userName', 'organizationName', 'status'
+    end
+
+    set_primary_key :developerId
+
+    validates_presence_of :firstName, :lastName, :userName, :email
+    validates_format_of :email, :with => /\A(|(([A-Za-z0-9]+_+)|([A-Za-z0-9]+\-+)|([A-Za-z0-9]+\.+)|([A-Za-z0-9]+\++))*[A-Za-z0-9]+@((\w+\-+)|(\w+\.))*\w{1,63}\.[a-zA-Z]{2,6})\Z/i
+
+    has_many :apps
+    
+    def id
+      developerId || email
+    end
+
+  end
+end

data/lib/apigee-platform/objects/developer_app.rb

@@ -0,0 +1,17 @@
+module ApigeePlatform::Objects
+  class DeveloperApp < App    
+    set_primary_key :name
+    set_prefix_options :developer_id => :developerId
+
+    self.site = self.site.to_s + "/developers/:developer_id"
+
+    validates_presence_of :name
+    belongs_to :developer
+    has_many :keys, :through => :credentials
+
+    def self.element_name
+      'app'
+    end
+
+  end
+end

data/lib/apigee-platform/objects/developer_app_key.rb

@@ -0,0 +1,7 @@
+module ApigeePlatform::Objects
+  class DeveloperAppKey < Key
+    set_prefix_options :developer_id => :developerId, :app_name => :name
+    self.site = self.site.to_s + "/developers/:developer_id/apps/:app_name"
+    set_primary_key :consumerKey
+  end
+end

data/lib/apigee-platform/objects/key.rb

@@ -0,0 +1,49 @@
+module ApigeePlatform::Objects
+  #abstract class, describes behavior of api keys, nested in developer_app and company_app
+  class Key < Base
+    def self.element_name
+      'key'
+    end
+
+    def approve
+      connection.post element_path
+    end
+
+    def add_product(product_name)
+      unless apiproducts[product_name]
+        connection.post element_path, {
+          :apiProducts => apiproducts.keys + [product_name]
+        }.to_json
+        apiproducts[product_name] = 'pending'
+      end
+    end
+
+    def approve_product(product_name)
+      return false unless apiproducts[product_name]
+      connection.post "#{element_path}/apiproducts/#{product_name}?action=approve", '', {'Content-Type' => 'application/octet-stream'}
+      apiproducts[product_name] = 'approved'
+    end
+    
+    def revoke_product(product_name)
+      return false unless apiproducts[product_name]
+      connection.post "#{element_path}/apiproducts/#{product_name}?action=revoke", '', {'Content-Type' => 'application/octet-stream'}
+      apiproducts[product_name] = 'revoked'
+    end
+
+    def remove_product(product_name)
+      return false unless apiproducts[product_name]
+      connection.delete "#{element_path}/apiproducts/#{product_name}"
+      apiproducts.delete(product_name)
+      true
+    end
+
+    def apiproducts
+      self.attributes['apiProducts']
+    end
+
+    def onload
+      self.attributes['apiProducts'] = self.attributes['apiProducts'].inject({}){|res, el| res[el.apiproduct] = el.status; res  }
+    end
+
+  end
+end

data/lib/apigee-platform/version.rb

@@ -0,0 +1,10 @@
+module ApigeePlatform
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 2
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/spec/associations_spec.rb

@@ -0,0 +1,130 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class MortalKombat
+  include ApigeePlatform::Associations
+  attr_accessor :mk_id
+  has_many :characters
+
+  def self.primary_key
+    :mk_id
+  end
+
+  def self.find(*args)
+    x = self.new
+    x.mk_id = 9
+    if args.first == :all
+      [x]
+    else
+      x
+    end
+  end
+end
+
+class MortalKombatCharacter
+  include ApigeePlatform::Associations
+  attr_accessor :char_id, :mk_id
+
+  belongs_to :mortal_kombat
+  has_many :locations, :through => 'maps'
+
+  def initialize(*args)
+    @params = args
+  end
+
+  def self.prefix_options
+    {:version => :mk_id} 
+  end  
+
+  def self.find(*args)
+    x = self.new
+    x.char_id = 'Jax'
+    if args.first == :all
+      [x]
+    else
+      x
+    end
+  end
+
+  def maps
+    [ 
+      OpenStruct.new(:attributes => {:name => 'Kuatan'}), 
+      OpenStruct.new(:attributes => {:name => 'Street'}), 
+      OpenStruct.new(:attributes => {:name => 'Swamp'})]
+  end
+end
+
+class MortalKombatCharacterLocation
+  attr_accessor :name
+  def initialize(params, prefix_params={})
+    params.each{|k,v| instance_variable_set("@#{k}", v)}
+  end
+
+  def self.prefix_options 
+    {:char_id => :char_id}
+  end
+
+  def self.instantiate_record(params, prefix_params={})
+    self.new(params, prefix_params)
+  end
+end
+
+
+describe 'class with has_many association' do 
+  subject { MortalKombat.new }
+  it 'can find all nested objects' do 
+    subject.should respond_to(:characters)
+    subject.characters.should be_kind_of(Array)
+  end
+
+  it 'has method to find subobject' do 
+    subject.should respond_to(:character)
+  end
+
+  it 'is able to find subobject' do 
+    subject.character('Jax').should be_kind_of(MortalKombatCharacter)
+  end
+
+  it 'return children' do 
+    subject.characters.first.should be_kind_of(MortalKombatCharacter)
+  end
+
+  it 'can create subobject by getting requesting object without id' do
+    subject.character.should be_kind_of(MortalKombatCharacter)
+  end
+
+  it 'has method for creating subobject' do 
+    subject.create_character.should be_kind_of(MortalKombatCharacter)
+  end
+
+  it 'sets prefix parameters for subobject' do 
+    subject.instance_variable_set(:@mk_id, 10)
+    pp = subject.create_character.instance_variable_get(:@params)
+    pp.should include({:mk_id=>10})
+  end
+end
+
+describe 'class with belongs_to association' do 
+  subject { MortalKombatCharacter.new }
+  it 'has method to get parent' do
+    subject.should respond_to(:mortal_kombat)
+  end
+
+  it 'return object of correct class when getting parent' do 
+    subject.mortal_kombat.should be_kind_of(MortalKombat)
+  end
+
+end
+
+describe 'class with belongs_to(:through => ..) association' do 
+  subject { MortalKombatCharacter.new }
+  it 'has method to nested collection' do
+    subject.should respond_to(:locations)
+  end
+
+  it 'returns nested objects from method passed in \'through\' ' do 
+    subject.locations.count.should == subject.maps.count
+    subject.locations.map(&:name).to_set.should == subject.maps.map{|el| el.attributes[:name]}.to_set
+  end
+
+end
+

data/spec/custom_attributes_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'custom attrs' do 
+  it 'make data accessible as hash elements' do 
+    obj = OpenStruct.new :attributes => {'attributes' => [{'name' => 'name', 'value' => 'Kitana'}]}
+    c = ApigeePlatform::CustomAttributes.new obj 
+    c['name'].should == obj.attributes['attributes'].first['value']
+  end
+
+  it 'sets new values in source object' do 
+    obj = OpenStruct.new :attributes => {'attributes' => []}
+    c = ApigeePlatform::CustomAttributes.new obj 
+    c['name'] = 'Johnny Cage'
+    obj.attributes['attributes'].first['name'].should == 'name'
+    obj.attributes['attributes'].first['value'].should == 'Johnny Cage'
+  end
+
+  it 'return names of data variables' do 
+    obj = OpenStruct.new :attributes => {'attributes' => [
+      {'name' => 'world',   'value' => 'MK'}, 
+      {'name' => 'fighter', 'value' => 'Kano'}
+    ]}
+    c = ApigeePlatform::CustomAttributes.new obj 
+    c.keys.to_set.should == ["world", "fighter"].to_set
+  end
+
+  it 'can delete data from source object' do 
+    obj = OpenStruct.new :attributes => {'attributes' => [{'name' => 'name', 'value' => 'Kitana'}]}
+    c = ApigeePlatform::CustomAttributes.new obj 
+    c.delete('name')
+    obj.attributes['attributes'].should be_empty
+  end
+
+end

data/spec/objects/developer_app_key_spec.rb

@@ -0,0 +1,112 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+
+describe 'DeveloperAppKey' do 
+  before :all do 
+    @app_name = 'testapp'
+    @developer_email = 'sampledev@example.com'
+    @developer_id    = 'F1bPGroWVtO9PATt'
+    @apiproduct_name = 'myapiproduct'
+    @new_apiproduct_name = 'mytest'
+    @consumer_key    = 'OOdAwgpyifxXPUeMDGKJBqDDDfDK12AS'
+    @credentials = [
+      {
+        "apiProducts"     => [{"apiproduct" => @apiproduct_name, "status" => "approved"}], 
+        "attributes"      => [], 
+        "consumerKey"     => @consumer_key, 
+        "consumerSecret"  => "lkECj1mAUzfBmdtD", 
+        "scopes"          => [], 
+        "status"          => "approved"
+      }
+    ]
+    @app = {
+      :name         => @app_name,
+      :appId        => '35eaba24-c340-48a2-819e-34d81993f9ab',
+      :developerId  => @developer_id,
+
+      :accessType     => "read", 
+      :appFamily      => "default", 
+      :attributes     => [{"name"=>"Developer", "value"=>@developer_email}, {"name"=>"DisplayName", "value"=>@app_name}, {"name"=>"Notes", "value"=>""}, {"name"=>"lastModifier", "value"=>""}], 
+      :callbackUrl    => "http://example.com", 
+      :createdAt      => 1369488501956, 
+      :createdBy      => "adminui@apigee.com", 
+      :credentials    => @credentials, 
+      :lastModifiedAt => 1369555151917, 
+      :lastModifiedBy => @developer_email, 
+      :scopes         => [], 
+      :status         => "approved"
+    }
+
+    ActiveResource::HttpMock.respond_to do |mock|
+      org = ApigeePlatform::Objects::Base.config[:organization]
+      mock.get "/v1/o/#{org}/developers/#{@developer_id}/apps/#{@app_name}", GET_HEADERS, @app.to_json
+      mock.post "/v1/o/#{org}/developers/#{@developer_id}/apps/#{@app_name}/keys/#{@consumer_key}", POST_HEADERS, {"apiProducts"=>["smtp_public_api", @new_apiproduct_name]}.to_json
+      mock.post "/v1/o/#{org}/developers/#{@developer_id}/apps/#{@app_name}/keys/#{@consumer_key}/apiproducts/mytest?action=approve", NO_CONTENT_HEADERS, nil, 204
+      mock.post "/v1/o/#{org}/developers/#{@developer_id}/apps/#{@app_name}/keys/#{@consumer_key}/apiproducts/mytest?action=revoke", NO_CONTENT_HEADERS, nil, 204
+      mock.delete "/v1/o/#{org}/developers/#{@developer_id}/apps/#{@app_name}/keys/#{@consumer_key}/apiproducts/mytest", GET_HEADERS, nil, 204
+    end
+  end
+
+  subject { ApigeePlatform::Objects::DeveloperApp.find(@app_name, :params => {:developer_id => @developer_id}) }
+
+  it 'has keys' do 
+    subject.should respond_to(:keys)
+  end
+
+  describe 'Key' do 
+    subject { ApigeePlatform::Objects::DeveloperApp.find(@app_name, :params => {:developer_id => @developer_id}).keys.first }
+    it 'has api products from nested credentials' do
+      subject.apiproducts[@credentials.first['apiProducts'].first['apiproduct']].should == @credentials.first['apiProducts'].first['status']
+    end
+
+    it 'can add product' do 
+      subject.should respond_to(:add_product)
+    end
+
+    it 'can approve product' do 
+      subject.should respond_to(:approve_product)
+    end
+
+    it 'can revoke product' do 
+      subject.should respond_to(:revoke_product)
+    end
+
+    it 'can remove product' do 
+      subject.should respond_to(:remove_product)
+    end
+
+    it 'saves new product' do 
+      subject.add_product(@new_apiproduct_name)
+      subject.apiproducts[@new_apiproduct_name].should be_present
+    end
+
+    it 'saves new product' do 
+      subject.add_product(@new_apiproduct_name)
+      subject.apiproducts[@new_apiproduct_name].should be_present
+    end
+
+    it 'approves product' do 
+      subject.add_product(@new_apiproduct_name)
+      subject.approve_product(@new_apiproduct_name)
+      subject.apiproducts[@new_apiproduct_name].should == 'approved'
+    end    
+
+    it 'revokes product' do 
+      subject.add_product(@new_apiproduct_name)
+      subject.revoke_product(@new_apiproduct_name)
+      subject.apiproducts[@new_apiproduct_name].should == 'revoked'
+    end    
+
+    it 'removes product' do 
+      subject.add_product(@new_apiproduct_name)
+      subject.remove_product(@new_apiproduct_name)
+      subject.apiproducts[@new_apiproduct_name].should_not be_present
+    end    
+
+  end
+
+end
+
+
+
+