zaui_zapi 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6895797708a101030535d4af23599951ca25c4a3
-  data.tar.gz: 721ca130713a7ef990e474bed2680138a5dbb8dd
+  metadata.gz: 2603818d4cbdef47080f90af717209755afd29f0
+  data.tar.gz: f4d5727dcfa29d39133d13b8762c5a0375d089e9
 SHA512:
-  metadata.gz: 9ab22654091c58032f49c166eaf7f84b4a8e9dd48867c6a8a6900df9702e5e2d5deb0c40b1a1cb275140c21e708d5229c8bd018111387f5b7374e24330d7d45b
-  data.tar.gz: 6e0a6e7d2447a5943928c1c9413e7458325cc02aa77752588a8029e60d4930e1c3d5265fbf9e27469a5c3ce3d1a7e63df30cb570b3538be41d2a34f404cca6ad
+  metadata.gz: 911be11613a1207627f3ceec5bd7479a691d95a48bfc86dcfafb6cbbaefb456eb6b2886a3c84f4f47d03d3084eed35769723f7ac58a6b8e724bfcfbf19a4985b
+  data.tar.gz: c2eca43692963b6d82db7b7fe9e388c0ac430a41066998a76362c6622925e1686432f81c42da89914de101ab91340d1b7b62aa0989a8495f397a7e4dc0552271

data/README.md

@@ -1,2 +1,10 @@
-# zaui_zapi v 0.0.1
+# zaui_zapi
 A gem to provide the communication layer with the Zaui.com zAPI and your application.
+
+### Installation
+Add this to your project's Gemfile
+```gem 'zaui_zapi'```
+
+
+#### Notes
+This gem is currently under heavy development so watch this page regularly for new releases as they become available.  There is plenty of work to do to get this gem usable for the entire zAPI interface, I encourge you to contribute.

data/lib/version.rb

@@ -1 +1 @@
-VERSION = '0.0.2'
+VERSION = '0.1.0'

data/lib/zapi.rb

@@ -1,3 +1,6 @@
+require 'net/http'
+require 'uri'
+
 class Zapi
 
   attr_reader :uri, :response, :responder

data/lib/zapi_activity_categories.rb

@@ -4,13 +4,12 @@ class ZapiActivityCategories
 
   def initialize session:, zapi: nil, xml_generator: nil
     @zapi = zapi || Zapi.new()
-    @generate_xml = xml_generator || ZapiXML.new()
+    @generate_xml = xml_generator || ZapiXML.new(session: session)
     @session = session
   end
 
   def index user_id: session.user_id, api_token: session.api_token
-    categories_xml = generate_xml.get_activity_categories(user_id: user_id, api_token: api_token)
-puts categories_xml.inspect
+    categories_xml = generate_xml.get_activity_categories
     @response = zapi.request(xml: categories_xml)
   end
 

data/lib/zapi_agent.rb

@@ -0,0 +1,83 @@
+class ZapiAgent
+
+  attr_reader :response, :zapi, :generate_xml, :responder
+
+  def initialize username:, password:, zapi: nil, xml_generator: nil, responder: nil
+    @zapi = zapi || Zapi.new()
+    @generate_xml = xml_generator  || ZapiXML.new()
+    @responder = responder || ZapiObject
+    @response = _login username: username, password: password
+  end
+
+  def is_logged_in?
+    response_msg == "Login Successful" && _method_name == 'zapiAgentLogin'
+  end
+
+  def response_msg
+    response.try(:[],'methodErrorMessage')
+  end
+
+  def session_hash
+    {
+      user_id: _user_id,
+      account_id: _account_id,
+      account_type: _account_type,
+      cart_id: _cart_id,
+      api_token: _api_token,
+      username: _username,
+      firstname: _firstname,
+      lastname: _lastname,
+      fullname: _fullname
+    }
+  end
+
+  def session hash: session_hash
+    responder.new(hash: hash)
+  end
+
+  def _login username:, password:
+    login_xml = generate_xml.agent_login(username: username, password: password)
+    zapi.request(xml: login_xml)
+  end
+
+  def _user_id
+    response.try(:[],'zapiUserId').to_i
+  end
+
+  def _account_id
+    response.try(:[],'zapiAccountId').to_i
+  end
+
+  def _account_type
+    response.try(:[],'zapiAccountType').to_i
+  end
+
+  def _cart_id
+    response.try(:[],'cartId')
+  end
+
+  def _api_token
+    response.try(:[],'zapiApiToken')
+  end
+
+  def _username
+    response.try(:[],'zapiUsername')
+  end
+
+  def _firstname
+    response.try(:[],'firstName')
+  end
+
+  def _lastname
+    response.try(:[],'lastName')
+  end
+
+  def _fullname
+    [_firstname, _lastname].compact.join(" ") if _firstname || _lastname
+  end
+
+  def _method_name
+    response.try(:[],'methodName')
+  end
+
+end

data/lib/zapi_employee.rb

@@ -5,7 +5,7 @@ class ZapiEmployee
   def initialize username:, password:, zapi: nil, xml_generator: nil, responder: nil
     @zapi = zapi || Zapi.new()
     @generate_xml = xml_generator  || ZapiXML.new()
-    @responder = responder || ZapiSession
+    @responder = responder || ZapiObject
     @response = _login username: username, password: password
   end
 
@@ -32,11 +32,11 @@ class ZapiEmployee
   end
 
   def session hash: session_hash
-    responder.new(session_hash: hash)
+    responder.new(hash: hash)
   end
 
   def _login username:, password:
-    login_xml = generate_xml.login(username: username, password: Digest::MD5.hexdigest(password))
+    login_xml = generate_xml.agent_login(username: username, password: Digest::MD5.hexdigest(password))
     zapi.request(xml: login_xml)
   end
 

data/lib/{zapi_session.rb → zapi_object.rb}

@@ -1,7 +1,7 @@
-class ZapiSession
+class ZapiObject
 
-  def initialize session_hash:
-    _generate hash: session_hash
+  def initialize hash:
+    _generate hash: hash
   end
 
   def _generate hash:

data/lib/zapi_package_categories.rb

@@ -0,0 +1,21 @@
+class ZapiPackageCategories
+
+  attr_reader :response, :zapi, :generate_xml, :session
+
+  def initialize session:, zapi: nil, xml_generator: nil
+    @zapi = zapi || Zapi.new()
+    @generate_xml = xml_generator || ZapiXML.new(session: session)
+    @session = session
+  end
+
+  def index user_id: session.user_id, api_token: session.api_token
+    categories_xml = generate_xml.get_package_categories
+    @response = zapi.request(xml: categories_xml)
+  end
+
+  def to_a
+    # convert received categoires to enumberable array
+
+  end
+
+end

data/lib/zapi_response.rb

@@ -11,7 +11,7 @@ class Zapi::ZapiResponse
   end
 
   def raw_hash
-    Hash.from_xml raw_xml
+    Hash.from_xml(raw_xml).with_indifferent_access
   end
 
   def api_version

data/lib/zapi_xml.rb

@@ -1,44 +1,313 @@
 class ZapiXML
 
-  def login username:, password:
-    _wrap_xml_request({
-      zapiUsername: username,
-      zapiPassword: password,
-      zapiMethod: {
-        methodName: 'zapiMobileLogin',
-        mobileData: {
-          mobileDeviceData: {
-            model: '',
-            name: '',
-            systemName: '',
-            systemVersion: ''
-          },
-          iosLocationServiceData: {
-            altitude: '',
-            coordinate: '',
-            course: '',
-            horizontalAccuracy: '',
-            verticalAccuracy: '',
-            speed: '',
-            timeStamp: '',
-          }
+  attr_reader :session
+
+  def initialize session: nil
+    @session = session
+  end
+
+  def agent_login username:, password:
+    _wrap_xml_request(
+      { "methodName" => 'zapiAgentLogin' },
+      { "zapiUsername" => username, "zapiPassword" => password }
+    )
+  end
+
+  def mobile_login username:, password:
+    _wrap_xml_request(
+      { "methodName" => 'zapiMobileLogin' },
+      { "zapiUsername" => username, "zapiPassword" => password }
+    )
+  end
+
+  def get_package_categories
+    _wrap_xml_request({
+      "methodName" => 'zapiGetPackageCategories'
+    })
+  end
+
+  def get_packages_by_category_id id
+    _wrap_xml_request({
+      "methodName" => 'zapiGetPackagesByCategoryId',
+      "categoryId" => id
+    })
+  end
+
+  def get_package_details_by_package_id id
+    _wrap_xml_request({
+      "methodName" => 'zapiGetPackageDetailsByPackageId',
+      "packageId" => id
+    })
+  end
+
+  def add_package_to_cart hash: {}
+    _wrap_xml_request({
+      "methodName" => "zapiAddPackageToCart",
+      "cartId" => session.cart_id,
+      "packageId" => hash[:package_id],
+      "passengers" => {
+        "adults" => hash[:adults].to_i,
+        "students" => hash[:students].to_i,
+        "children" => hash[:children].to_i
+      },
+      "activities" => _activities(hash[:activities]),
+      "products" => nil
+    })
+  end
+
+  def get_activity_categories
+    _wrap_xml_request({
+      "methodName" => 'zapiGetActivityCategories'
+    })
+  end
+
+  def get_activities_by_category_id id
+    _wrap_xml_request({
+      "methodName" => 'zapiGetActivitiesByCategoryId',
+      "categoryId" => id
+    })
+  end
+
+  def get_merchandise_categories
+    _wrap_xml_request({
+      "methodName" => 'zapiGetMerchandiseCategories'
+    })
+  end
+
+  def get_merchandise_by_category_id id
+    _wrap_xml_request({
+      "methodName" => 'zapiGetMerchandiseByCategoryId',
+      "categoryId" => id
+    })
+  end
+
+  def clear_cart_session
+    _wrap_xml_request({
+      "methodName" => 'zapiClearCartSession',
+      "cartId" => session.cart_id
+    })
+  end
+
+  def get_cart_contents
+    _wrap_xml_request({
+      "methodName" => 'zapiGetCartContents',
+      "cartId" => session.cart_id
+    })
+  end
+
+  def update_notes_to_cart notes
+    _wrap_xml_request({
+      "methodName" => 'zapiUpdateNotesToCart',
+      "cartId" => session.cart_id,
+      "notes" => notes
+    })
+  end
+
+  def update_customer_details_to_cart first_name:, last_name:, phone:, email:
+    _wrap_xml_request({
+      "methodName" => 'zapiUpdateCustomerDetailsToCart',
+      "cartId" => session.cart_id,
+      "firstName" => first_name,
+      "lastName" => last_name,
+      "mobileNumber" => phone,
+      "email" => email
+    })
+  end
+
+  def add_product_to_cart product_id:, quantity:
+    _wrap_xml_request({
+      "methodName" => 'zapiAddProductToCart',
+      "cartId" => session.cart_id,
+      "productId" => product_id,
+      "quantity" => quantity
+    })
+  end
+
+  def remove_product_cart_item product_id:
+    _wrap_xml_request({
+      "methodName" => 'zapiAddRemoveProductCartItem',
+      "cartId" => session.cart_id,
+      "productId" => product_id
+    })
+  end
+
+  def get_all_merchandise_by_name product_name:
+    _wrap_xml_request({
+      "methodName" => 'zapiGetAllMerchandiseByName',
+      "productNameToSearch" => product_name
+    })
+  end
+
+  def get_all_activities_by_name activity_name:
+    _wrap_xml_request({
+      "methodName" => 'zapiGetAllActivitiesByName',
+      "activityNameToSearch" => activity_name
+    })
+  end
+
+  def get_all_activities_by_date date:
+    _wrap_xml_request({
+      "methodName" => 'zapiGetAllActivitiesByDate',
+      "activityDate" => date.strftime("%Y-%m-%d")
+    })
+  end
+
+  def add_activity_to_cart hash: {}
+    _wrap_xml_request({
+      "methodName" => 'zapiAddActivityToCart',
+      "cartId" => session.cart_id,
+      "activityId" => hash[:activity_id],
+      "activityDate" => hash[:activity_date],
+      "activityEndDate" => hash[:activity_end_date],
+      "rentalStartTime" => hash[:rental_start_time],
+      "rentalEndTime" => hash[:rental_end_time],
+      "pricingOptions" => {
+        "option" => {
+          "optionId" => hash[:pricing_option_id],
+          "quantity" => hash[:pricing_option_quantity]
+        }
+      },
+      "passengers" => {
+        "seniors" => hash[:seniors].to_I,
+        "adults" => hash[:adults].to_i,
+        "students" => hash[:students].to_i,
+        "children" => hash[:children].to_i,
+        "infants" => hash[:infants].to_i
+      },
+      "activityTime" => hash[:activity_time],
+      "pickupLocationId" => hash[:pickup_location_id],
+      "dropOffLocationId" => hash[:dropoff_location_id]
+    })
+  end
+
+  def remove_activity_cart_item activity_id:, date:
+    _wrap_xml_request({
+      "methodName" => 'zapiRemoveActivityCartItem',
+      "cartId" => session.cart_id,
+      "activityId" => activity_id,
+      "activityDate" => date.strftime("%Y-%m-%d")
+    })
+  end
+
+  def get_activity_details_by_activity_id activity_id:, date: nil
+    hash = {
+      "methodName" => 'zapiGetActivityDetailsByActivityId',
+      "activityId" => activity_id
+    }
+    if date
+      hash.merge!({
+        "activityDate" => date.strftime("%Y-%m-%d")
+      })
+    end
+    _wrap_xml_request(hash)
+  end
+
+  def get_product_details_by_product_id product_id:
+    _wrap_xml_request({
+      "methodName" => 'zapiGetProductDetailsByProductId',
+      "productId" => product_id
+    })
+  end
+
+  def check_activity_inventory_by_date hash: {}
+    _wrap_xml_request({
+      "methodName" => 'zapiCheckActivityInventoryByDate',
+      "activityId" => hash[:activity_id],
+      "activityDate" => hash[:activity_date].strftime("%Y-%m-%d"),
+      "activityTime" => "HH:MM:SS",
+      "pickupLocationId" => hash[:pickup_location_id],
+      "dropoffLocationId" => hash[:dropoff_location_id],
+      "requestedPassengers" => {
+        "seniors" => hash[:seniors],
+        "adults" => hash[:adults],
+        "students" => hash[:students],
+        "children" => hash[:children],
+        "infants" => hash[:infants]
+      },
+      "pricingOptions" => {
+        "option" => {
+          "optionId" => hash[:option_id],
+          "quantity" => hash[:quantity]
         }
       }
     })
   end
 
-  def get_activity_categories user_id:, api_token:
+  def check_product_inventory product_id:, quantity:
+    _wrap_xml_request({
+      "methodName" => 'zapiCheckProductInventory',
+      "productId" => product_id,
+      "quantity" => quantity
+    })
+  end
+
+  def process_cart_with_payment hash: {}
     _wrap_xml_request({
-      zapiToken: api_token,
-      zapiUserId: user_id,
-      zapiMethod: {
-        methodName: 'zapiGetActivityCategories'
+      "methodName" => 'zapiProcessCartWithPayment',
+      "cartId" => session.cart_id,
+      "paymentMethod" => {
+        "paymentMethodType" => 2000
+      },
+      "paymentGatewayId" => nil,
+      "creditCardDetails" => {
+        "nameOnCard" => hash[:name_on_card],
+        "number" => hash[:cc_num],
+        "expMonth" => hash[:expiration_month],
+        "expYear" => hash[:expiration_year],
+        "csv" => hash[:csv],
+        "cardType" => hash[:card_type],
+        "rawSwipeData" => nil,
+        "track1Data" => nil,
+        "track2Data" => nil
       }
     })
   end
 
-  def _wrap_xml_request hash
-    hash.to_xml(:root => 'request')
+  def promotion_code_apply promo_code:
+    _wrap_xml_request({
+      "methodName" => 'zapiPromotionCodeApply',
+      "cartId" => session.cart_id,
+      "promotCodeName" => promo_code
+    })
+  end
+
+  def gift_certificate_apply gift_certificate:
+    _wrap_xml_request({
+      "methodName" => 'zapiGiftCertificateApply',
+      "cartId" => session.cart_id,
+      "giftCertificate" => gift_certificate
+    })
+  end
+
+
+  def _wrap_xml_request method, params = {}
+    if session
+      request = params.merge({
+        'zapiToken' => session.api_token,
+        'zapiUserId' => session.user_id,
+        'zapiAccountId' => session.account_id,
+        'zapiMethod' => method
+      })
+    else
+      request = params.merge({ 'zapiMethod' => method })
+    end
+    request.to_xml(:root => 'request')
+  end
+
+  def _activities activities
+    activites.map do |a|
+      {
+        "activityId" => nil,
+        "activityDate" => nil,
+        "activityTime" => nil,
+        "pickupLocationId" => nil,
+        "pickupAddress" => nil,
+        "dropOffLocationId" => nil,
+        "dropoffAddress" => nil,
+        "pricingOptions" => nil
+      }
+    end
+    {'activity' => activities}
   end
 
 end

data/lib/zaui.rb

@@ -0,0 +1,31 @@
+class Zaui
+
+  attr_reader :zapi, :xml, :responder
+
+  def initialize zapi: nil, zapi_xml: nil, responder: nil, session: nil
+    @zapi = zapi || Zapi.new()
+    @xml = zapi_xml || ZapiXML.new(session: ZapiObject.new(hash: session))
+    @responder = responder || ZapiObject
+  end
+
+  def get_activity_categories
+    raw = _zapi(xml.get_activity_categories)[:categories][:category]
+  end
+
+  def get_activities_by_category_id id
+    raw = _zapi(xml.get_activities_by_category_id(id))[:activities][:activity]
+  end
+
+  def get_package_categories
+    raw = _zapi xml.get_package_categories[:categories][:category]
+  end
+
+  def get_packages_by_category_id id
+    raw = _zapi(xml.get_packages_by_category_id(id))
+  end
+
+  def _zapi xml
+    zapi.request(xml: xml)
+  end
+
+end

data/lib/zaui_zapi.rb

@@ -1,6 +1,8 @@
+require 'zaui'
 require 'zapi'
+require 'zapi_agent'
 require 'zapi_response'
-require 'zapi_session'
+require 'zapi_object'
 require 'zapi_employee'
 require 'zapi_xml'
 require 'zapi_activity_categories'

data/zaui_zapi.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = VERSION
   spec.authors       = ['Shane Kretzmann']
   spec.email         = ["Shane.Kretzmann@gmail.com"]
-  spec.summary       = %q{Zaui zAPI interface gem}
+  spec.summary       = %q{Zaui.com zAPI interface gem}
   spec.description   = %q{Provide ruby methods to interact with Zaui zAPI}
   spec.homepage      = "https://github.com/uberdragon/zaui_zapi"
   spec.license       = "GNU GENERAL PUBLIC LICENSE Version 2"
@@ -19,4 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "minitest"
+
+  spec.add_runtime_dependency 'rails'
+  spec.add_runtime_dependency 'activesupport'
 end

metadata

@@ -1,27 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: zaui_zapi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Shane Kretzmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-10 00:00:00.000000000 Z
+date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Provide ruby methods to interact with Zaui zAPI
@@ -31,16 +59,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - LICENSE
 - README.md
 - lib/version.rb
 - lib/zapi.rb
 - lib/zapi_activity_categories.rb
+- lib/zapi_agent.rb
 - lib/zapi_employee.rb
+- lib/zapi_object.rb
+- lib/zapi_package_categories.rb
 - lib/zapi_response.rb
-- lib/zapi_session.rb
 - lib/zapi_xml.rb
+- lib/zaui.rb
 - lib/zaui_zapi.rb
 - zaui_zapi.gemspec
 homepage: https://github.com/uberdragon/zaui_zapi
@@ -53,18 +84,18 @@ 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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Zaui zAPI interface gem
+summary: Zaui.com zAPI interface gem
 test_files: []