megam_api 1.5.rc7 → 1.5.4

data/lib/megam/core/addons.rb

@@ -0,0 +1,169 @@
+module Megam
+    class Addons < Megam::RestAdapter
+        def initialize(o)
+            @id = nil
+            @provider_id = nil
+            @account_id = nil
+            @provider_name = nil
+            @options = []
+            @created_at = nil
+            @some_msg = {}
+            super(o)
+        end
+
+        def addons
+            self
+        end
+
+        def id(arg=nil)
+            if arg != nil
+                @id = arg
+            else
+                @id
+            end
+        end
+
+        def provider_id(arg=nil)
+            if arg != nil
+                @provider_id= arg
+            else
+                @provider_id
+            end
+        end
+
+        def account_id(arg=nil)
+            if arg != nil
+                @account_id= arg
+            else
+                @account_id
+            end
+        end
+
+        def provider_name(arg=nil)
+            if arg != nil
+                @provider_name = arg
+            else
+                @provider_name
+            end
+        end
+
+        def options(arg=[])
+            if arg != []
+                @options = arg
+            else
+                @options
+            end
+        end
+
+        def created_at(arg=nil)
+            if arg != nil
+                @created_at = arg
+            else
+                @created_at
+            end
+        end
+
+        def some_msg(arg=nil)
+            if arg != nil
+                @some_msg = arg
+            else
+                @some_msg
+            end
+        end
+
+        def error?
+            crocked  = true if (some_msg.has_key?(:msg_type) && some_msg[:msg_type] == "error")
+        end
+
+        # Transform the ruby obj ->  to a Hash
+        def to_hash
+            index_hash = Hash.new
+            index_hash["json_claz"] = self.class.name
+            index_hash["id"] = id
+            index_hash["provider_id"] = provider_id
+            index_hash["account_id"] = account_id
+            index_hash["provider_name"] = provider_name
+            index_hash["options"] = options
+            index_hash["created_at"] = created_at
+            index_hash
+        end
+
+        # Serialize this object as a hash: called from JsonCompat.
+        # Verify if this called from JsonCompat during testing.
+        def to_json(*a)
+            for_json.to_json(*a)
+        end
+
+        def for_json
+            result = {
+                "id" => id,
+                "provider_id" => provider_id,
+                "account_id" => account_id,
+                "provider_name" => provider_name ,
+                "options" => options,
+                "created_at" => created_at
+            }
+            result
+        end
+
+        #
+        def self.json_create(o)
+            adn = new({})
+            adn.id(o["id"]) if o.has_key?("id")
+            adn.provider_id(o["provider_id"]) if o.has_key?("provider_id")
+            adn.account_id(o["account_id"]) if o.has_key?("account_id")
+            adn.provider_name(o["provider_name"]) if o.has_key?("provider_name")
+            adn.options(o["options"]) if o.has_key?("options")
+            adn.created_at(o["created_at"]) if o.has_key?("created_at")
+            #success or error
+            adn.some_msg[:code] = o["code"] if o.has_key?("code")
+            adn.some_msg[:msg_type] = o["msg_type"] if o.has_key?("msg_type")
+            adn.some_msg[:msg]= o["msg"] if o.has_key?("msg")
+            adn.some_msg[:links] = o["links"] if o.has_key?("links")
+            adn
+        end
+
+        def self.from_hash(o,tmp_email=nil, tmp_api_key=nil, tmp_host=nil)
+            adn = self.new(tmp_email, tmp_api_key, tmp_host)
+            adn.from_hash(o)
+            adn
+        end
+
+        def from_hash(o)
+            @id        = o[:id] if o.has_key?(:id)
+            @provider_id = o[:provider_id] if o.has_key?(:provider_id)
+            @account_id = o[:account_id] if o.has_key?(:account_id)
+            @provider_name   = o[:provider_name] if o.has_key?(:provider_name)
+            @options     = o[:options] if o.has_key?(:options)
+            @created_at   = o[:created_at] if o.has_key?(:created_at)
+            self
+        end
+
+        def self.create(o,tmp_email=nil, tmp_api_key=nil, tmp_host=nil)
+            acct = from_hash(o,tmp_email, tmp_api_key, tmp_host)
+            acct.create
+        end
+
+        # Create the addons via the REST API
+        def create
+            megam_rest.post_addons(to_hash)
+        end
+
+        # Load all addons -
+        # returns a AddonsCollection
+        # don't return self. check if the Megam::AddonsCollection is returned.
+
+        # Show a particular addon by  provider_name,
+        # Megam::Addon
+        def self.show(p_name,tmp_email=nil, tmp_api_key=nil, tmp_host=nil)
+            pre = self.new(tmp_email,tmp_api_key, tmp_host)
+            pre.megam_rest.get_addon(p_name)
+        end
+
+
+        def to_s
+            Megam::Stuff.styled_hash(to_hash)
+        end
+
+    end
+end

data/lib/megam/core/addons_collection.rb

@@ -0,0 +1,121 @@
+module Megam
+    class AddonsCollection
+        include Enumerable
+
+        attr_reader :iterator
+        def initialize
+            @addons = Array.new
+            @addons_by_name = Hash.new
+            @insert_after_idx = nil
+        end
+
+        def all_addons
+            @addons
+        end
+
+        def [](index)
+            @addons[index]
+        end
+
+        def []=(index, arg)
+            is_megam_addons(arg)
+            @addons[index] = arg
+            @addons_by_name[arg.account_id] = index
+        end
+
+        def <<(*args)
+            args.flatten.each do |a|
+                is_megam_addons(a)
+                @addons << a
+                @addons_by_name[a.account_id] =@addons.length - 1
+            end
+            self
+        end
+
+        # 'push' is an alias method to <<
+        alias_method :push, :<<
+
+        def insert(addons)
+            is_megam_addons(addons)
+            if @insert_after_idx
+                # in the middle of executing a run, so any predefs inserted now should
+                # be placed after the most recent addition done by the currently executing
+                # addons
+                @addons.insert(@insert_after_idx + 1, addons)
+                # update name -> location mappings and register new addons
+                @addons_by_name.each_key do |key|
+                    @addons_by_name[key] += 1 if@addons_by_name[key] > @insert_after_idx
+                end
+                @addons_by_name[addons.account_id] = @insert_after_idx + 1
+                @insert_after_idx += 1
+            else
+                @addons << addons
+                @addons_by_name[addons.account_id] =@addons.length - 1
+            end
+        end
+
+        def each
+            @addons.each do |addons|
+                yield addons
+            end
+        end
+
+        def each_index
+            @addons.each_index do |i|
+                yield i
+            end
+        end
+
+        def empty?
+            @addons.empty?
+        end
+
+        def lookup(addons)
+            lookup_by = nil
+            if Addons.kind_of?(Megam::Addons)
+                lookup_by = addons.account_id
+            elsif addons.kind_of?(String)
+                lookup_by = addons
+            else
+                raise ArgumentError, "Must pass a Megam::Addons or String to lookup"
+            end
+            res =@addons_by_name[lookup_by]
+            unless res
+                raise ArgumentError, "Cannot find a addons matching #{lookup_by} (did you define it first?)"
+            end
+            @addons[res]
+        end
+
+        def to_s
+            @addons.join(", ")
+        end
+
+        def for_json
+            to_a.map { |item| item.to_s }
+        end
+
+        def to_json(*a)
+            Megam::JSONCompat.to_json(for_json, *a)
+        end
+
+        def self.json_create(o)
+            collection = self.new()
+            o["results"].each do |addons_list|
+                addons_array = addons_list.kind_of?(Array) ? addons_list : [ addons_list ]
+                addons_array.each do |addons|
+                    collection.insert(addons)
+                end
+            end
+            collection
+        end
+
+        private
+
+        def is_megam_addons(arg)
+            unless arg.kind_of?(Megam::Addons)
+                raise ArgumentError, "Members must be Megam::addons's"
+            end
+            true
+        end
+    end
+end

data/lib/megam/core/json_compat.rb

@@ -48,6 +48,10 @@ module Megam
         MEGAM_EVENTSBILLINGCOLLECTION         = 'Megam::EventsBillingCollection'.freeze
         MEGAM_EVENTSSTORAGE                   = 'Megam::EventsStorage'.freeze
         MEGAM_EVENTSSTORAGECOLLECTION         = 'Megam::EventsStorageCollection'.freeze
+        MEGAM_SUBSCRIPTIONS                 = 'Megam::Subscriptions'.freeze
+        MEGAM_SUBSCRIPTIONSCOLLECTION       = 'Megam::SubscriptionsCollection'.freeze
+        MEGAM_ADDONS                       = 'Megam::Addons'.freeze
+        MEGAM_ADDONSCOLLECTION            = 'Megam::AddonsCollection'.freeze
         MEGAM_PROMOS                          = 'Megam::Promos'.freeze
 
         class <<self
@@ -203,7 +207,15 @@ module Megam
                     Megam::Billingtransactions
                 when MEGAM_BILLINGTRANSACTIONSCOLLECTION
                     Megam::BillingtransactionsCollection
-                when MEGAM_PROMOS
+                when MEGAM_SUBSCRIPTIONS
+                    Megam::Subscriptions
+                when MEGAM_SUBSCRIPTIONSCOLLECTION
+                    Megam::SubscriptionsCollection
+                when MEGAM_ADDONS
+                    Megam::Addons
+                when MEGAM_ADDONSCOLLECTION
+                    Megam::AddonsCollection
+               when MEGAM_PROMOS
                     Megam::Promos
                 else
                     fail JSON::ParserError, "Unsupported `json_class` type '#{json_class}'"

data/lib/megam/core/rest_adapter.rb

@@ -3,7 +3,9 @@ module Megam
         attr_reader :email
         attr_reader :api_key
         attr_reader :host
-        attr_reader :password
+        # the name :password is used as attr_accessor in accounts,
+        # hence we use gpassword
+        attr_reader :gpassword
         attr_reader :org_id
         attr_reader :headers
 
@@ -13,7 +15,7 @@ module Megam
             @email = o[:email]
             @api_key = o[:api_key] || nil
             @host = o[:host]
-            @password = o[:password] || nil
+            @gpassword = o[:password] || nil
             @org_id = o[:org_id]
             @headers = o[:headers]
         end
@@ -27,7 +29,7 @@ module Megam
               :email => email,
               :api_key => api_key,
               :org_id => org_id,
-              :password => password,
+              :password => gpassword,
               :host => host
             }
             if headers

data/lib/megam/core/subscriptions.rb

@@ -0,0 +1,167 @@
+module Megam
+    class Subscriptions < Megam::RestAdapter
+        def initialize(o)
+            @id = nil
+            @account_id = nil
+            @model = nil
+            @license = nil
+            @trial_ends = nil
+            @created_at = nil
+            @some_msg = {}
+            super(o)
+        end
+
+        def subscriptions
+            self
+        end
+
+        def id(arg=nil)
+            if arg != nil
+                @id = arg
+            else
+                @id
+            end
+        end
+
+        def account_id(arg=nil)
+            if arg != nil
+                @account_id= arg
+            else
+                @account_id
+            end
+        end
+
+        def model(arg=nil)
+            if arg != nil
+                @model = arg
+            else
+                @model
+            end
+        end
+
+        def license(arg=nil)
+            if arg != nil
+                @license= arg
+            else
+                @license
+            end
+        end
+
+        def trial_ends(arg=nil)
+            if arg != nil
+                @trial_ends = arg
+            else
+                @trial_ends
+            end
+        end
+
+        def created_at(arg=nil)
+            if arg != nil
+                @created_at = arg
+            else
+                @created_at
+            end
+        end
+
+        def some_msg(arg=nil)
+            if arg != nil
+                @some_msg = arg
+            else
+                @some_msg
+            end
+        end
+
+        def error?
+            crocked  = true if (some_msg.has_key?(:msg_type) && some_msg[:msg_type] == "error")
+        end
+
+        # Transform the ruby obj ->  to a Hash
+        def to_hash
+            index_hash = Hash.new
+            index_hash["json_claz"] = self.class.name
+            index_hash["id"] = id
+            index_hash["account_id"] = account_id
+            index_hash["model"] = model
+            index_hash["license"] = license
+            index_hash["trial_ends"] = trial_ends
+            index_hash["created_at"] = created_at
+            index_hash
+        end
+
+        # Serialize this object as a hash: called from JsonCompat.
+        # Verify if this called from JsonCompat during testing.
+        def to_json(*a)
+            for_json.to_json(*a)
+        end
+
+        def for_json
+            result = {
+                "id" => id,
+                "account_id" => account_id,
+                "model" => model,
+                "license" => license,
+                "trial_ends" => trial_ends,
+                "created_at" => created_at
+            }
+            result
+        end
+
+        #
+        def self.json_create(o)
+            sbs = new({})
+            sbs.id(o["id"]) if o.has_key?("id")
+            sbs.account_id(o["account_id"]) if o.has_key?("account_id")
+            sbs.model(o["model"]) if o.has_key?("model")
+            sbs.license(o["license"]) if o.has_key?("license")
+            sbs.trial_ends(o["trial_ends"]) if o.has_key?("trial_ends")
+            sbs.created_at(o["created_at"]) if o.has_key?("created_at")
+            #success or error
+            sbs.some_msg[:code] = o["code"] if o.has_key?("code")
+            sbs.some_msg[:msg_type] = o["msg_type"] if o.has_key?("msg_type")
+            sbs.some_msg[:msg]= o["msg"] if o.has_key?("msg")
+            sbs.some_msg[:links] = o["links"] if o.has_key?("links")
+            sbs
+        end
+
+        def self.from_hash(o,tmp_email=nil, tmp_api_key=nil, tmp_host=nil)
+            sbs = self.new(tmp_email, tmp_api_key, tmp_host)
+            sbs.from_hash(o)
+            sbs
+        end
+
+        def from_hash(o)
+            @id        = o[:id] if o.has_key?(:id)
+            @account_id = o[:account_id] if o.has_key?(:account_id)
+            @model     = o[:model] if o.has_key?(:model)
+            @license   = o[:license] if o.has_key?(:license)
+            @trial_ends   = o[:trial_ends] if o.has_key?(:trial_ends)
+            @created_at   = o[:created_at] if o.has_key?(:created_at)
+            self
+        end
+
+        def self.create(o,tmp_email=nil, tmp_api_key=nil, tmp_host=nil)
+            acct = from_hash(o,tmp_email, tmp_api_key, tmp_host)
+            acct.create
+        end
+
+        # Create the subscriptions via the REST API
+        def create
+            megam_rest.post_subscriptions(to_hash)
+        end
+
+        # Load all subscriptions -
+        # returns a SubscriptionsCollection
+        # don't return self. check if the Megam::SubscriptionsCollection is returned.
+
+        def self.show(p_name,tmp_email=nil, tmp_api_key=nil, tmp_host=nil)
+            pre = self.new(tmp_email,tmp_api_key, tmp_host)
+            pre.megam_rest.get_subscription
+        end
+
+
+        def to_s
+            Megam::Stuff.styled_hash(to_hash)
+        end
+
+    end
+end