levelup 0.9.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in levelup_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    levelup (0.9.2)
+      httparty (~> 0.13.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    ast (2.0.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    httparty (0.13.1)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    multi_xml (0.5.5)
+    parser (2.1.9)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (1.99.2)
+    rake (10.3.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    rubocop (0.16.0)
+      parser (~> 2.1)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.1.4)
+    safe_yaml (1.0.3)
+    settingslogic (2.0.9)
+    slop (3.5.0)
+    vcr (2.9.0)
+    webmock (1.17.4)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  levelup!
+  rake (~> 10.3.1)
+  rspec (~> 2.14)
+  rspec-mocks (~> 2.14.6)
+  rubocop (~> 0.16.0)
+  settingslogic (~> 2.0.9)
+  vcr (~> 2.9.0)
+  webmock (~> 1.17.4)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 LevelUp
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 SCVNGR, Inc.
+
+MIT License
+
+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

@@ -0,0 +1,113 @@
+# LevelUp Ruby SDK
+
+Early alpha version of the LevelUp Ruby SDK - designed for e-commerce and online
+food ordering sites to provide the option to easily pay with a LevelUp account.
+
+Subject to drastic change without warning for duration of alpha period.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'levelup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install levelup
+
+## Usage
+
+1. Create an instance of the LevelUp client and authenticate it.
+
+```ruby
+api = Levelup::Api.new
+auth_response = api.access_tokens.create_for_app(
+  api_key: 'your_api_key',
+  client_secret: 'your_secret')
+api.app_access_token = auth_response.token
+
+# or if you've saved your access token (recommended) just:
+api = Levelup::Api.new(app_access_token: 'your_access_token')
+```
+
+2. Ensure you have permissions to manage orders for your merchant (if you haven't already done so)
+
+```ruby
+api.apps.permissions_requests.create(
+  email: 'merchant@email.com',
+  permission_keynames: ['manage_merchant_orders'])
+# Approve the request through the merchant email and the LevelUp API
+# will post you a merchant access token.
+
+# See http://developer.thelevelup.com/api-reference/v15/user-permissions/
+# for more on receiving access tokens.
+```
+
+3. Ask a user for permission to make an order for them.
+
+```ruby
+api.apps.permissions_requests.create(
+  email: 'user@email.com',
+  permission_keynames: ['create_orders'])
+# wait for the user to approve the request. you will receive a user
+# access token in the same manner as above.
+```
+
+3. Create an order for the specified merchant.
+
+```ruby
+response = api.orders.create(
+  identifier_from_merchant: '0123',
+  location_id: 321,
+  spend_amount: 350, # in cents; 350 = $3.50
+  items: [
+    {
+      # item data
+    }
+  ],
+  merchant_access_token: 'merchant-token',
+  user_access_token: 'user-token')
+```
+
+All other functions of the Ruby SDK mirror the v15 LevelUp API described at http://developer.thelevelup.com/
+as well as a very small number of v14 endpoints.
+
+## Errors
+
+If the LevelUp API returns an error response (Any HTTP code 400 or greater), it will return an object
+containing useful info about the error. It can be handled like so:
+```ruby
+error = api.access_tokens.create_for_app(
+  api_key: 'bogus_api_key',
+  client_secret: 'bogus_client_secret'
+)
+
+puts error.success? # => false
+puts error.headers['Cache-Control'] # => 'private' (Map of header names to values)
+puts error.status_code # => 422
+puts error.errors[0] # => object with message, object, property values
+puts error.errors[0].message # => 'API Key is invalid.'
+puts error.errors[0].property # => 'api_key'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/TheLevelup/pos-ruby-sdk/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Ensure that Rubocop gives you a clean bill of health
+```
+cd path/to/my/ruby-sdk-folder
+rubocop
+```
+4. Ensure that all RSpec tests pass (and write some for your code!)
+```
+cd path/to/my/ruby-sdk-folder
+rspec
+```
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/levelup.gemspec

@@ -0,0 +1,32 @@
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+require 'levelup/configuration'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'levelup'
+  spec.version       = Levelup::Configuration::VERSION
+  spec.authors       = ['LevelUp POS Team']
+  spec.email         = ['pos-support@thelevelup.com']
+  spec.summary       = %q(A Ruby client for communicating with the LevelUp API)
+  spec.description   = %q(A tool to simplify, streamline, and quickly
+    communicate with the LevelUp REST API, allowing for companies to easily
+    implement the ability to pay with LevelUp on their e-commerce platforms.)
+  spec.homepage      = 'http://developer.thelevelup.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.3.1'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'rspec-mocks', '~> 2.14.6'
+  spec.add_development_dependency 'rubocop', '~> 0.16.0'
+  spec.add_development_dependency 'settingslogic', '~> 2.0.9'
+  spec.add_development_dependency 'vcr', '~> 2.9.0'
+  spec.add_development_dependency 'webmock', '~> 1.17.4'
+
+  spec.add_runtime_dependency 'httparty', '~> 0.13.1'
+end

data/lib/levelup.rb

@@ -0,0 +1,55 @@
+require 'httparty'
+
+require 'levelup/errors/invalid_request'
+require 'levelup/errors/unauthenticated'
+require 'levelup/configuration'
+
+require 'levelup/templates/data_parcel'
+require 'levelup/templates/user_address_data'
+require 'levelup/templates/merchant_authenticated'
+require 'levelup/templates/merchant_and_user_authenticated'
+require 'levelup/templates/user_authenticated'
+
+require 'levelup/requests/base'
+require 'levelup/requests/authenticate_app'
+require 'levelup/requests/authenticate_merchant'
+require 'levelup/requests/create_address'
+require 'levelup/requests/create_card'
+require 'levelup/requests/create_order'
+require 'levelup/requests/create_user'
+require 'levelup/requests/get_order'
+require 'levelup/requests/get_qr_code'
+require 'levelup/requests/get_user'
+require 'levelup/requests/give_merchant_credit'
+require 'levelup/requests/list_addresses'
+require 'levelup/requests/list_locations'
+require 'levelup/requests/list_orders'
+require 'levelup/requests/list_user_orders'
+require 'levelup/requests/refund_order'
+require 'levelup/requests/request_permissions'
+require 'levelup/requests/show_permissions_request'
+
+require 'levelup/responses/success'
+require 'levelup/responses/error'
+
+require 'levelup/endpoints/base'
+require 'levelup/endpoints/access_tokens'
+require 'levelup/endpoints/app_users'
+require 'levelup/endpoints/apps'
+require 'levelup/endpoints/credit_cards'
+require 'levelup/endpoints/location_orders'
+require 'levelup/endpoints/merchant_funded_credits'
+require 'levelup/endpoints/merchant_locations'
+require 'levelup/endpoints/merchant_orders'
+require 'levelup/endpoints/orders'
+require 'levelup/endpoints/permissions_requests'
+require 'levelup/endpoints/qr_codes'
+require 'levelup/endpoints/specific_location'
+require 'levelup/endpoints/specific_merchant'
+require 'levelup/endpoints/specific_order'
+require 'levelup/endpoints/specific_permissions_request'
+require 'levelup/endpoints/user_addresses'
+require 'levelup/endpoints/user_orders'
+require 'levelup/endpoints/users'
+
+require 'levelup/api'

data/lib/levelup/api.rb

@@ -0,0 +1,102 @@
+# The LevelUp Ruby SDK provides an interface for Ruby and Rails developers to
+# easily and intuitively access the LevelUp API, specifically for the purpose
+# of utilizing LevelUp for online ordering and web payments.
+
+module Levelup
+  # This API is the base class that handles all requests made to the LevelUp
+  # API.
+  class Api
+    # Token to access app-authenticated endpoints
+    attr_writer :app_access_token
+    # App API key to automatically generate an app access token
+    attr_writer :api_key
+    # App secret to automatically generate an app access token
+    attr_writer :secret
+
+    # Accepts any combination of the listed parameters, though +api_key+ and
+    # +secret+ work in tandem.
+    def initialize(app_access_token: nil, api_key: nil, secret: nil)
+      self.app_access_token = app_access_token
+      self.api_key = api_key
+      self.secret = secret
+    end
+
+    # Generates an interface for the +access_tokens+ endpoint.
+    def access_tokens
+      Endpoints::AccessTokens.new(
+        api_key: api_key,
+        secret: secret
+      )
+    end
+
+    # Generates an interface for the +apps+ endpoint.
+    def apps
+      Endpoints::Apps.new(app_access_token)
+    end
+
+    # Verifies if an access token is present for app-authenticated endpoints
+    def app_authenticated?
+      !@app_access_token.nil?
+    end
+
+    def credit_cards
+      Endpoints::CreditCards.new
+    end
+
+    # Generates the interface for the +locations+ endpoint for a specific
+    # location ID.
+    def locations(location_id)
+      Endpoints::SpecificLocation.new(location_id)
+    end
+
+    # Generates an interface for the +merchants+ endpoint for a specific
+    # merchant ID.
+    def merchants(merchant_id)
+      Endpoints::SpecificMerchant.new(merchant_id)
+    end
+
+    def merchant_funded_credits
+      Endpoints::MerchantFundedCredits.new
+    end
+
+    # Generates the interface for the +orders+ endpoint. Supply an order UUID if
+    # you would like to access endpoints for a specific order, otherwise, supply
+    # no parameters.
+    def orders(order_uuid = nil)
+      if order_uuid
+        Endpoints::SpecificOrder.new(order_uuid)
+      else
+        Endpoints::Orders.new
+      end
+    end
+
+    def qr_codes
+      Endpoints::QrCodes.new
+    end
+
+    # Generates an interface the +user_addresses+ endpoint.
+    def user_addresses
+      Endpoints::UserAddresses.new
+    end
+
+    def users
+      Endpoints::Users.new
+    end
+
+    private
+
+    attr_reader :api_key, :secret
+
+    def app_access_token
+      unless app_authenticated?
+        auto_auth = access_tokens.create_for_app
+
+        if auto_auth.success?
+          @app_access_token = auto_auth.token
+        end
+      end
+
+      @app_access_token
+    end
+  end
+end

data/lib/levelup/configuration.rb

@@ -0,0 +1,23 @@
+module Levelup
+  class Configuration
+    VERSION = '0.9.2'
+    DEFAULT_API_VERSION = :v15
+
+    class << self
+      attr_accessor :base_api_url
+    end
+
+    self.base_api_url = 'https://api.thelevelup.com/'
+
+    def self.api_url(version)
+      base_api_url + VERSIONS[version]
+    end
+
+    private
+
+    VERSIONS = {
+      v14: 'v14',
+      v15: 'v15'
+    }
+  end
+end

data/lib/levelup/endpoints/access_tokens.rb

@@ -0,0 +1,40 @@
+module Levelup
+  module Endpoints
+    # The endpoint holding all functions related to the management of access
+    # tokens.
+    class AccessTokens < Base
+      # The API key assigned to your app. Preconfigured key.
+      attr_writer :api_key
+      # The client secret assigned to your app. Preconfigured key.
+      attr_writer :secret
+
+      def initialize(api_key: nil, secret: nil)
+        @api_key = api_key
+        @secret = secret
+      end
+
+      # Generates a new app access token. If passed no parameters, attempts to
+      # pass the preconfigured API key and client secret to the endpoint.
+      def create_for_app(app_auth_request = nil)
+        request = build_request(app_auth_request || { api_key: @api_key,
+          client_secret: @secret },
+          Requests::AuthenticateApp)
+
+        request.send_to_api(:post, endpoint_path)
+      end
+
+      # Generates a new merchant access token.
+      def create_for_merchant(merchant_auth_request)
+        request = build_request(merchant_auth_request,
+          Requests::AuthenticateMerchant)
+        request.send_to_api(:post, endpoint_path(:v14))
+      end
+
+      private
+
+      def path
+        'access_tokens'
+      end
+    end
+  end
+end