megam_api 0.36 → 0.38

data/lib/megam/core/billings.rb

@@ -0,0 +1,242 @@
+##
+## Copyright [2013-2015] [Megam Systems]
+##
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+##
+## http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+module Megam
+  class Billings < Megam::ServerAPI
+    
+    def initialize(email=nil, api_key=nil)
+      @id = nil
+      @accounts_id = nil
+      @line1 = nil
+      @line2 = nil
+      @country_code = nil
+      @postal_code=nil
+      @state=nil
+      @phone = nil
+      @bill_type = nil
+      @created_at = nil
+      @some_msg = {}
+      super(email, api_key)
+    end
+
+    def billings
+      self
+    end
+
+    
+    def id(arg=nil)
+      if arg != nil
+        @id = arg
+      else
+      @id
+      end
+    end
+
+    def accounts_id(arg=nil)
+      if arg != nil
+        @accounts_id= arg
+      else
+      @accounts_id
+      end
+    end
+
+    def line1(arg=nil)
+      if arg != nil
+        @line1 = arg
+      else
+      @line1
+      end
+    end
+
+    def line2(arg=nil)
+      if arg != nil
+        @line2 = arg
+      else
+      @line2
+      end
+    end
+
+    def country_code(arg=nil)
+      if arg != nil
+        @country_code = arg
+      else
+      @country_code
+      end
+    end
+
+    def postal_code(arg=nil)
+      if arg != nil
+        @postal_code= arg
+      else
+      @postal_code
+      end
+    end
+
+    def state(arg=nil)
+      if arg != nil
+        @state= arg
+      else
+      @state
+      end
+    end
+
+   def phone(arg=nil)
+      if arg != nil
+        @phone= arg
+      else
+      @phone
+      end
+    end
+    
+    def bill_type(arg=nil)
+      if arg != nil
+        @bill_type = arg
+      else
+      @bill_type
+      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["accounts_id"] = accounts_id
+      index_hash["line1"] = line1
+      index_hash["line2"] = line2
+      index_hash["country_code"] = country_code
+      index_hash["postal_code"] = postal_code
+      index_hash["state"] = state
+      index_hash["phone"] = phone
+      index_hash["bill_type"] = bill_type
+      index_hash["created_at"] = created_at
+      index_hash["some_msg"] = some_msg
+      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,
+        "accounts_id" => accounts_id,
+        "line1" => line1,
+        "line2" => line2,
+        "country_code" => country_code,
+        "postal_code" => postal_code,
+        "state" => state,
+        "phone" => phone,
+        "bill_type" => bill_type,
+        "created_at" => created_at
+      }
+      result
+    end
+
+    #
+    def self.json_create(o)
+      cts = new
+      cts.id(o["id"]) if o.has_key?("id")
+      cts.accounts_id(o["accounts_id"]) if o.has_key?("accounts_id")
+      cts.line1(o["line1"]) if o.has_key?("line1")
+      cts.line2(o["line2"]) if o.has_key?("line2")
+      cts.country_code(o["country_code"]) if o.has_key?("country_code")
+      cts.postal_code(o["postal_code"]) if o.has_key?("postal_code")
+      cts.state(o["state"]) if o.has_key?("state")
+      cts.phone(o["phone"]) if o.has_key?("phone")
+      cts.bill_type(o["bill_type"]) if o.has_key?("bill_type")
+
+      cts.created_at(o["created_at"]) if o.has_key?("created_at")
+      #success or error
+      cts.some_msg[:code] = o["code"] if o.has_key?("code")
+      cts.some_msg[:msg_type] = o["msg_type"] if o.has_key?("msg_type")
+      cts.some_msg[:msg]= o["msg"] if o.has_key?("msg")
+      cts.some_msg[:links] = o["links"] if o.has_key?("links")
+      cts
+    end
+
+    def self.from_hash(o,tmp_email=nil, tmp_api_key=nil)
+      cts = self.new(tmp_email,tmp_api_key)
+      cts.from_hash(o)
+      cts
+    end
+
+    def from_hash(o)
+      @id        = o[:id] if o.has_key?(:id)
+      @accounts_id = o[:accounts_id] if o.has_key?(:accounts_id)
+      @line1   = o[:line1] if o.has_key?(:line1)
+      @line2     = o[:line2] if o.has_key?(:line2)
+      @country_code     = o[:country_code] if o.has_key?(:country_code)
+      @postal_code   = o[:postal_code] if o.has_key?(:postal_code)
+      @state   = o[:state] if o.has_key?(:state)
+      @bill_type   = o[:bill_type] if o.has_key?(:bill_type)
+      @created_at   = o[:created_at] if o.has_key?(:created_at)
+      self
+    end
+
+    def self.create(o,tmp_email=nil, tmp_api_key=nil)
+      acct = from_hash(o,tmp_email, tmp_api_key)
+      acct.create
+    end
+
+    # Create the billings via the REST API
+    def create
+      megam_rest.post_billings(to_hash)
+    end
+
+    # Load all billings -
+    # returns a billingsCollection
+    # don't return self. check if the Megam::billingsCollection is returned.
+    def self.list(tmp_email=nil, tmp_api_key=nil)
+      cts = self.new(tmp_email, tmp_api_key)
+      cts.megam_rest.get_billings
+    end
+
+    # Show a particular billings by name,
+    # Megam::billings
+    def self.show(p_name,tmp_email=nil, tmp_api_key=nil)
+      pre = self.new(tmp_email, tmp_api_key)
+      pre.megam_rest.get_billing(p_name)
+    end
+
+    def to_s
+      Megam::Stuff.styled_hash(to_hash)
+    end
+
+  end
+end

data/lib/megam/core/billings_collection.rb

@@ -0,0 +1,144 @@
+##
+## Copyright [2013-2015] [Megam Systems]
+##
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+##
+## http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+module Megam
+  class BillingsCollection
+    include Enumerable
+
+    attr_reader :iterator
+    def initialize
+      @billings = Array.new
+      @billings_by_name = Hash.new
+      @insert_after_idx = nil
+    end
+
+    def all_billings
+      @billings
+    end
+
+    def [](index)
+      @billings[index]
+    end
+
+    def []=(index, arg)
+      is_megam_billings(arg)
+      @billings[index] = arg
+      @billings_by_name[arg.repo_name] = index
+    end
+
+    def <<(*args)
+      args.flatten.each do |a|
+        is_megam_billings(a)
+        @billings << a
+        @billings_by_name[a.repo_name] =@billings.length - 1
+      end
+      self
+    end
+
+    # 'push' is an alias method to <<
+    alias_method :push, :<<
+
+    def insert(billings)
+      is_megam_billings(billings)
+      if @insert_after_idx
+        # in the middle of executing a run, so any billings inserted now should
+        # be placed after the most recent addition done by the currently executing
+        # billings
+        @billings.insert(@insert_after_idx + 1, billings)
+        # update name -> location mappings and register new billings
+        @billings_by_name.each_key do |key|
+        @billings_by_name[key] += 1 if@billings_by_name[key] > @insert_after_idx
+        end
+        @billings_by_name[billings.repo_name] = @insert_after_idx + 1
+        @insert_after_idx += 1
+      else
+      @billings << billings
+      @billings_by_name[billings.repo_name] =@billings.length - 1
+      end
+    end
+
+    def each
+      @billings.each do |billings|
+        yield billings
+      end
+    end
+
+    def each_index
+      @billings.each_index do |i|
+        yield i
+      end
+    end
+
+    def empty?
+      @billings.empty?
+    end
+
+    def lookup(billings)
+      lookup_by = nil
+      if billings.kind_of?(Megam::Billings)
+      lookup_by = billings.repo_name
+      elsif billings.kind_of?(String)
+      lookup_by = billings
+      else
+        raise ArgumentError, "Must pass a Megam::billings or String to lookup"
+      end
+      res =@billings_by_name[lookup_by]
+      unless res
+        raise ArgumentError, "Cannot find a billings matching #{lookup_by} (did you define it first?)"
+      end
+      @billings[res]
+    end
+
+    # Transform the ruby obj ->  to a Hash
+    def to_hash
+      index_hash = Hash.new
+      self.each do |billings|
+        index_hash[billings.repo_name] = billings.to_s
+      end
+      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 self.json_create(o)
+      collection = self.new()
+      o["results"].each do |billings_list|
+        billings_array = billings_list.kind_of?(Array) ? billings_list : [ billings_list ]
+        billings_array.each do |billings|
+          collection.insert(billings)
+        end
+      end
+      collection
+    end
+
+    private
+
+    def is_megam_billings(arg)
+      unless arg.kind_of?(Megam::Billings)
+        raise ArgumentError, "Members must be Megam::Billings"
+      end
+      true
+    end
+
+    def to_s
+      Megam::Stuff.styled_hash(to_hash)
+    end
+
+  end
+end

data/lib/megam/core/credithistories.rb

@@ -0,0 +1,191 @@
+# Copyright:: Copyright (c) 2012, 2014 Megam Systems
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module Megam
+  class Credithistories < Megam::ServerAPI
+    
+    def initialize(email=nil, api_key=nil)
+      @id = nil
+      @accounts_id = nil
+      @bill_type = nil
+      @credit_amount = nil
+      @currency_type = nil      
+      @created_at = nil
+      @some_msg = {}
+      super(email, api_key)
+    end
+
+    def credithistories
+      self
+    end
+
+    
+    def id(arg=nil)
+      if arg != nil
+        @id = arg
+      else
+      @id
+      end
+    end
+
+    def accounts_id(arg=nil)
+      if arg != nil
+        @accounts_id= arg
+      else
+      @accounts_id
+      end
+    end
+
+    def bill_type(arg=nil)
+      if arg != nil
+        @bill_type = arg
+      else
+      @bill_type
+      end
+    end
+
+    def credit_amount(arg=nil)
+      if arg != nil
+        @credit_amount = arg
+      else
+      @credit_amount
+      end
+    end
+
+    def currency_type(arg=nil)
+      if arg != nil
+        @currency_type = arg
+      else
+      @currency_type
+      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["accounts_id"] = accounts_id
+      index_hash["bill_type"] = bill_type
+      index_hash["credit_amount"] = credit_amount
+      index_hash["currency_type"] = currency_type    
+      index_hash["created_at"] = created_at
+      index_hash["some_msg"] = some_msg
+      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,
+        "accounts_id" => accounts_id,
+        "bill_type" => bill_type,
+        "credit_amount" => credit_amount,
+        "currency_type" => currency_type,
+        "created_at" => created_at
+      }
+      result
+    end
+
+    #
+    def self.json_create(o)
+      cts = new
+      cts.id(o["id"]) if o.has_key?("id")
+      cts.accounts_id(o["accounts_id"]) if o.has_key?("accounts_id")
+      cts.bill_type(o["bill_type"]) if o.has_key?("bill_type")
+      cts.credit_amount(o["credit_amount"]) if o.has_key?("credit_amount")
+      cts.currency_type(o["currency_type"]) if o.has_key?("currency_type")
+
+      cts.created_at(o["created_at"]) if o.has_key?("created_at")
+      #success or error
+      cts.some_msg[:code] = o["code"] if o.has_key?("code")
+      cts.some_msg[:msg_type] = o["msg_type"] if o.has_key?("msg_type")
+      cts.some_msg[:msg]= o["msg"] if o.has_key?("msg")
+      cts.some_msg[:links] = o["links"] if o.has_key?("links")
+      cts
+    end
+
+    def self.from_hash(o,tmp_email=nil, tmp_api_key=nil)
+      cts = self.new(tmp_email,tmp_api_key)
+      cts.from_hash(o)
+      cts
+    end
+
+    def from_hash(o)
+      @id        = o[:id] if o.has_key?(:id)
+      @accounts_id = o[:accounts_id] if o.has_key?(:accounts_id)
+      @bill_type   = o[:bill_type] if o.has_key?(:bill_type)
+      @credit_amount     = o[:credit_amount] if o.has_key?(:credit_amount)
+      @currency_type     = o[:currency_type] if o.has_key?(:currency_type)
+      @created_at   = o[:created_at] if o.has_key?(:created_at)
+      self
+    end
+
+    def self.create(o,tmp_email=nil, tmp_api_key=nil)
+      acct = from_hash(o,tmp_email, tmp_api_key)
+      acct.create
+    end
+
+    # Create the credit histories via the REST API
+    def create
+      megam_rest.post_credithistories(to_hash)
+    end
+
+    # Load all credithistories -
+    # returns a credithistoriesCollection
+    # don't return self. check if the Megam::ccredithistoriesCollection is returned.
+    def self.list(tmp_email=nil, tmp_api_key=nil)
+      cts = self.new(tmp_email, tmp_api_key)
+      cts.megam_rest.get_credithistories
+    end
+
+    # Show a particular credithistories by name,
+    # Megam::credithistories
+    def self.show(p_name,tmp_email=nil, tmp_api_key=nil)
+      pre = self.new(tmp_email, tmp_api_key)
+      pre.megam_rest.get_credithistories(p_name)
+    end
+
+    def to_s
+      Megam::Stuff.styled_hash(to_hash)
+    end
+
+  end
+end