ordrin 0.1.4 → 1.0.0

data/lib/ordrin.rb

@@ -1,58 +1,358 @@
-require_relative 'ordrin/restaurant'
-require_relative 'ordrin/user'
-require_relative 'ordrin/order'
-require_relative 'ordrin/data'
+require_relative 'ordrin/api_helper'
 
 module Ordrin
   class APIs
+    def initialize(api_key, servers=:test)
+      @helper = APIHelper.new(api_key, servers)
+    end
+
+    
+    # order endpoints
+    
+    def order_guest(args)
+=begin
+      Arguments:
+    rid--Ordr.in's unique restaurant identifier for the restaurant.
+    em--The customer's email address
+    tray--Represents a tray of menu items in the format '[menu item id]/[qty],[option id],...,[option id]'
+    tip--Tip amount in dollars and cents
+    first_name--The customer's first name
+    last_name--The customer's last name
+    phone--The customer's phone number
+    zip--The zip code part of the address
+    addr--The street address
+    city--The city part of the address
+    state--The state part of the address
+    card_number--Credit card number
+    card_cvc--3 or 4 digit security code
+    card_expiry--The credit card expiration date.
+    card_bill_addr--The credit card's billing street address
+    card_bill_city--The credit card's billing city
+    card_bill_state--The credit card's billing state
+    card_bill_zip--The credit card's billing zip code
+    card_bill_phone--The credit card's billing phone number
+
+    Keyword Arguments:
+    addr2--The second part of the street address, if needed
+    card_name--Full name as it appears on the credit card
+    card_bill_addr2--The second part of the credit card's biling street address.
+
+
+    Either
+    delivery_date--Delivery date
+    delivery_time--Delivery time
+    OR
+    delivery_date--Delivery date
+=end
+      @helper.call_endpoint(:order, "order_guest", ["rid"], args)
+    end
+    
+    def order_user(args)
+=begin
+      Arguments:
+    rid--Ordr.in's unique restaurant identifier for the restaurant.
+    tray--Represents a tray of menu items in the format '[menu item id]/[qty],[option id],...,[option id]'
+    tip--Tip amount in dollars and cents
+    first_name--The customer's first name
+    last_name--The customer's last name
+    email -- The user's email
+    current_password -- The user's current password
+
+    Keyword Arguments:
+
+
+    Either
+    phone--The customer's phone number
+    zip--The zip code part of the address
+    addr--The street address
+    addr2--The second part of the street address, if needed
+    city--The city part of the address
+    state--The state part of the address
+    OR
+    nick--The delivery location nickname. (From the user's addresses)
+    Either
+    card_name--Full name as it appears on the credit card
+    card_number--Credit card number
+    card_cvc--3 or 4 digit security code
+    card_expiry--The credit card expiration date.
+    card_bill_addr--The credit card's billing street address
+    card_bill_addr2--The second part of the credit card's biling street address.
+    card_bill_city--The credit card's billing city
+    card_bill_state--The credit card's billing state
+    card_bill_zip--The credit card's billing zip code
+    card_bill_phone--The credit card's billing phone number
+    OR
+    card_nick--The credit card nickname. (From the user's credit cards)
+    Either
+    delivery_date--Delivery date
+    delivery_time--Delivery time
+    OR
+    delivery_date--Delivery date
+=end
+      @helper.call_endpoint(:order, "order_user", ["rid"], args)
+    end
+    
+    
+    # restaurant endpoints
+    
+    def delivery_check(args)
+=begin
+      Arguments:
+    datetime--Delivery date and time
+    rid--Ordr.in's unique restaurant identifier for the restaurant.
+    addr--Delivery location street address
+    city--Delivery location city
+    zip--The zip code part of the address
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:restaurant, "delivery_check", ["rid", "datetime", "zip", "city", "addr"], args)
+    end
+    
+    def delivery_list(args)
+=begin
+      Arguments:
+    datetime--Delivery date and time
+    addr--Delivery location street address
+    city--Delivery location city
+    zip--The zip code part of the address
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:restaurant, "delivery_list", ["datetime", "zip", "city", "addr"], args)
+    end
+    
+    def fee(args)
+=begin
+      Arguments:
+    datetime--Delivery date and time
+    rid--Ordr.in's unique restaurant identifier for the restaurant.
+    subtotal--The cost of all items in the tray in dollars and cents.
+    tip--The tip in dollars and cents.
+    addr--Delivery location street address
+    city--Delivery location city
+    zip--The zip code part of the address
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:restaurant, "fee", ["rid", "subtotal", "tip", "datetime", "zip", "city", "addr"], args)
+    end
+    
+    def restaurant_details(args)
+=begin
+      Arguments:
+    rid--Ordr.in's unique restaurant identifier for the restaurant.
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:restaurant, "restaurant_details", ["rid"], args)
+    end
+    
+    
+    # user endpoints
+    
+    def change_password(args)
+=begin
+      Arguments:
+    email--The user's email address
+    password--The user's new password
+    current_password -- The user's current password
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:user, "change_password", ["email"], args)
+    end
+    
+    def create_account(args)
+=begin
+      Arguments:
+    email--The user's email address
+    pw--The user's password
+    first_name--The user's first name
+    last_name--The user's last name
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:user, "create_account", ["email"], args)
+    end
+    
+    def create_addr(args)
+=begin
+      Arguments:
+    email--The user's email address
+    nick--The nickname of this address
+    phone--The customer's phone number
+    zip--The zip code part of the address
+    addr--The street address
+    city--The city part of the address
+    state--The state part of the address
+    current_password -- The user's current password
+
+    Keyword Arguments:
+    addr2--The second part of the street address, if needed
+
+
+=end
+      @helper.call_endpoint(:user, "create_addr", ["email", "nick"], args)
+    end
+    
+    def create_cc(args)
+=begin
+      Arguments:
+    email--The user's email address
+    nick--The nickname of this address
+    card_number--Credit card number
+    card_cvc--3 or 4 digit security code
+    card_expiry--The credit card expiration date.
+    bill_addr--The credit card's billing street address
+    bill_city--The credit card's billing city
+    bill_state--The credit card's billing state
+    bill_zip--The credit card's billing zip code
+    bill_phone--The credit card's billing phone number
+    current_password -- The user's current password
+
+    Keyword Arguments:
+    bill_addr2--The second part of the credit card's biling street address.
+
+
+=end
+      @helper.call_endpoint(:user, "create_cc", ["email", "nick"], args)
+    end
+    
+    def delete_addr(args)
+=begin
+      Arguments:
+    email--The user's email address
+    nick--The nickname of this address
+    current_password -- The user's current password
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:user, "delete_addr", ["email", "nick"], args)
+    end
+    
+    def delete_cc(args)
+=begin
+      Arguments:
+    email--The user's email address
+    nick--The nickname of this address
+    current_password -- The user's current password
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:user, "delete_cc", ["email", "nick"], args)
+    end
     
-    attr_reader :restaurant, :user, :order
-    
-    # Sets up this module to make API calls. The first argument is the developer's
-    # API key. The other three are the URLs corresponding to the three parts of the api.
-    # No API calls will work until this function is called. API objects will only be
-    # instantiated for URLs that are passed in.
-
-    # Arguments:
-    # api_key -- The developer's API key
-    # servers -- How the server URLs should be set. Must be :production, :test, or :custom
-    # restaurant_url -- The base url for the restaurant API. Can only be set if servers==:custom.
-    # user_url -- The base url for the user API. Can only be set if servers==:custom.
-    # order_url -- The base url for the order API. Can only be set if servers==:custom.
-    def initialize(api_key, servers, restaurant_url=nil, user_url=nil, order_url=nil)
-      @api_key = api_key
-      if servers!=:custom
-        unless restaurant_url.nil? and user_url.nil? and order_url.nil?
-          raise ArgumentError.new("Individual URL parameters can only be set if servers is set to :custom")
-        end
-      end
-      if servers==:production
-        restaurant_url = "https://r.ordr.in/"
-        user_url = "https://u.ordr.in/"
-        order_url = "https://o.ordr.in/"
-      elsif servers==:test
-        restaurant_url = "https://r-test.ordr.in/"
-        user_url = "https://u-test.ordr.in/"
-        order_url = "https://o-test.ordr.in/"
-      elsif servers!=:custom
-        raise ArgumentError.new("servers must be set to :production, :test, or :custom")
-      end
-      unless restaurant_url.nil?
-        @restaurant = RestaurantApi.new(api_key, restaurant_url)
-      end
-      unless user_url.nil?
-        @user = UserApi.new(api_key, user_url)
-      end
-      unless order_url.nil?
-        @order = OrderApi.new(api_key, order_url)
-      end
-    end
-
-    def config
-      return {"API key" => api_key,
-        "Restaurant URL" => @restaurant.base_url,
-        "User URL" => @user.base_url,
-        "Order URL" => @order.base_url}
+    def get_account_info(args)
+=begin
+      Arguments:
+    email--The user's email address
+    current_password -- The user's current password
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:user, "get_account_info", ["email"], args)
     end
+    
+    def get_all_saved_addrs(args)
+=begin
+      Arguments:
+    email--The user's email address
+    current_password -- The user's current password
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:user, "get_all_saved_addrs", ["email"], args)
+    end
+    
+    def get_all_saved_ccs(args)
+=begin
+      Arguments:
+    email--The user's email address
+    current_password -- The user's current password
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:user, "get_all_saved_ccs", ["email"], args)
+    end
+    
+    def get_order(args)
+=begin
+      Arguments:
+    email--The user's email address
+    oid--Ordr.in's unique order id number.
+    current_password -- The user's current password
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:user, "get_order", ["email", "oid"], args)
+    end
+    
+    def get_order_history(args)
+=begin
+      Arguments:
+    email--The user's email address
+    current_password -- The user's current password
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:user, "get_order_history", ["email"], args)
+    end
+    
+    def get_saved_addr(args)
+=begin
+      Arguments:
+    email--The user's email address
+    nick--The nickname of this address
+    current_password -- The user's current password
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:user, "get_saved_addr", ["email", "nick"], args)
+    end
+    
+    def get_saved_cc(args)
+=begin
+      Arguments:
+    email--The user's email address
+    nick--The nickname of this address
+    current_password -- The user's current password
+
+    Keyword Arguments:
+
+
+=end
+      @helper.call_endpoint(:user, "get_saved_cc", ["email", "nick"], args)
+    end
+    
+    
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ordrin
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,28 +10,36 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2013-02-13 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.3
 description: Ordrin API wrapper. Used to simplify making calls to the Ordr.in API
   in Ruby
 email:
 - hackfood@ordr.in
-executables:
-- ordrindemo.rb
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/ordrin.rb
-- lib/ordrin/data.rb
-- lib/ordrin/errors.rb
-- lib/ordrin/normalize.rb
-- lib/ordrin/order.rb
-- lib/ordrin/ordrinapi.rb
-- lib/ordrin/restaurant.rb
-- lib/ordrin/user.rb
+- lib/ordrin/api_helper.rb
+- lib/ordrin/mutate.rb
+- lib/ordrin/schemas.json
 - lib/ordrin/cacert.pem
-- bin/ordrindemo.rb
-- LICENSE.txt
-- README.md
 homepage: https://github.com/ordrin/api-ruby
 licenses: []
 post_install_message: 

data/LICENSE.txt

@@ -1,7 +0,0 @@
-Copyright (c) 2012 ordr.in, inc.
-
-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

@@ -1,95 +0,0 @@
-Ordr.in Ruby API
-==================
-
-A Ruby wrapper for the Restaurant, User, and Order APIs provided by Ordr.in. Everything mentioned here is described in more detail in the documentation in the ruby files. The main API documentation can be found at http://ordr.in/developers.
-
-The demo script (`bin/ordrindemo.rb`) has examples of calling every function and initializing all of the data structures.
-
-Data Structures
----------------
-
-```python
-Ordrin::Data::Address(addr, city, state, zip, phone, addr2='')
-
-Ordrin::Data::CreditCard(name, expiry_month, expiry_year, bill_address, number, cvc)
-
-Ordrin::Data::UserLogin(email, password)
-
-Ordrin::Data::TrayItem(item_id, quantity, *options)
-
-Ordrin::Data::Tray(*items)
-```
-
-Exceptions
-----------
-
-```python
-Ordrin::Errors::ApiError(msg, text)
-
-Ordrin::Errors::ApiInvalidResponseError(msg)
-```
-
-API Initialization
-------------------
-
-```python
-api = Ordrin::APIs(developer_key, servers, restaurant_url, user_url, order_url)
-```
-
-Restaurant API Functions
-------------------------
-All of these functions are in the `ordrin.restaurant` module.
-
-```python
-api.restaurant.get_delivery_list(date_time, address)
-
-api.restaurant.get_delivery_check(retaurant_id, date_time, address)
-
-api.restaurant.get_fee(restaurant_id, subtotal, tip, date_time, address)
-
-api.restaurant.get_details(restaurant_id)
-```
-
-User API Functions
-------------------
-All of these functions are in the `ordrin.user` module.
-
-```python
-api.user.get(login)
-
-api.user.create(login, first_name, last_name)
-
-api.user.update(login, first_name, last_name)
-
-api.user.get_all_addresses(login)
-
-api.user.get_address(login, addr_nick)
-
-api.user.set_address(login, addr_nick, address)
-
-api.user.remove_address(login, addr_nick)
-
-api.user.get_all_credit_cards(login)
-
-api.user.get_credit_card(login, card_nick)
-
-api.user.set_credit_card(login, card_nick, credit_card)
-
-api.user.remove_credit_card(login, card_nick)
-
-api.user.get_order_history(login)
-
-api.user.get_order_detail(login, order_id)
-
-api.user.set_password(login, new_password)
-```
-
-Order API Functions
--------------------
-All of these functions are in the `ordrin.order` module.
-
-```python
-api.order.order(restaurant_id, tray, tip, delivery_date_time, first_name, last_name, address, credit_card, email=None, login=None)
-
-order_create_user(restaurant_id, tray, tip, delivery_date_time, first_name, last_name, address, credit_card, email, password)
-```