passworks 0.0.1

data/lib/passworks/client.rb

@@ -0,0 +1,53 @@
+module Passworks
+
+  # Client is the HTTP API Wrapper to comunicate with the Passworks API
+  #
+  class Client
+
+    include Passworks::Configuration
+    include Passworks::Request
+
+    def initialize(params={})
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        self.instance_variable_set(:"@#{key}", params[key])
+      end
+    end
+
+    # Check if the current {Client} instance options are equal to the passed ones
+    # @param options [Hash] options
+    # @return [Boolean]
+    def same_options?(options)
+      self.options == options
+    end
+
+    # @!method assets
+    #   Allows to to access the Assets API
+    #   @return [Passworks::RequestProxy]
+    # @!method boarding_passes
+    #   Allows to to access the Boarding Pass API
+    #   @return [Passworks::RequestProxy]
+    # @!method store_cards
+    #   Allows to to access the Store Cards API
+    #   @return [Passworks::RequestProxy]
+    # @!method coupons
+    #   Allows to to access the Coupons API
+    #   @return [Passworks::RequestProxy]
+    # @!method generics
+    #   Allows to to access the Generic API
+    #   @return [Passworks::RequestProxy]
+
+    %w(assets boarding_passes store_cards coupons generics).each do |collection_name|
+      define_method(collection_name) do
+        Passworks::RequestProxy.new(self, collection_name, nil)
+      end
+    end
+
+    def inspect
+      inspected = super
+      inspected.gsub!(/\@api_secret=(.+)/){ "@api_secret=\"**********\"" }
+      inspected
+    end
+
+  end
+
+end

data/lib/passworks/collection_proxy.rb

@@ -0,0 +1,46 @@
+require 'passworks/inflector'
+
+module Passworks
+  class CollectionProxy
+
+    include Enumerable
+    include Passworks::Inflector
+
+    attr_reader :collection_name, :collection_uuid, :client, :options
+
+    def initialize(client, collection_name, collection_uuid=nil, options={})
+      @collection_name  = collection_name
+      @collection_uuid  = collection_uuid
+      @client           = client
+      @options          = options
+    end
+
+    def each(&block)
+      next_page = nil
+      loop do
+        if next_page
+          response = client.get(collection_url, options.merge({query: {page: next_page}}))
+        else
+          response = client.get(collection_url, options)
+        end
+        response.data.each do |item_data|
+          yield resource_class.new(client, collection_name, item_data)
+        end
+        next_page = response.next_page
+        break if next_page.nil?
+      end
+      self
+    end
+
+    private
+
+      def collection_url
+        if collection_uuid
+          "#{collection_name}/#{collection_uuid}/passes"
+        else
+          collection_name
+        end
+      end
+
+  end
+end

data/lib/passworks/configuration.rb

@@ -0,0 +1,58 @@
+require 'passworks/version'
+
+module Passworks
+  module Configuration
+
+    VALID_CONNECTION_KEYS = [:endpoint, :user_agent].freeze
+
+    VALID_OPTION_KEYS     = [:api_username, :api_secret, :debug].freeze
+
+    # @!visibility private
+    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTION_KEYS
+
+    DEFAULT_ENDPOINT      = 'https://api.passworks.io'
+
+    DEFAULT_USER_AGENT    = "Passworks Ruby API Client/#{Passworks::VERSION} Ruby/#{RUBY_VERSION} Platform/#{RUBY_PLATFORM}"
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def configure
+      yield self
+    end
+
+    def reset!
+      Configuration.default_options.each do |key, value|
+        self.instance_variable_set(:"@#{key}", value)
+      end
+    end
+
+    def options
+      Configuration.default_options.keys.inject({}) do |hash, key|
+        hash[key] = self.instance_variable_get(:"@#{key}")
+        hash
+      end
+    end
+
+    # @!visibility private
+    def self.default_options
+      @default_options ||= {
+        endpoint:     ENV['PASSWORKS_ENDPOINT']     || DEFAULT_ENDPOINT   ,
+        user_agent:   ENV['PASSWORKS_USER_AGENT']   || DEFAULT_USER_AGENT ,
+        api_username: ENV['PASSWORKS_API_USERNAME']                       ,
+        api_secret:   ENV['PASSWORKS_API_SECRET']                         ,
+        debug:        false
+      }
+    end
+    # @return the endpoint address with API version appended
+    def endpoint
+      File.join(@endpoint, 'v1').to_s
+    end
+
+    class << self
+      def extended(base)
+        base.reset!
+      end
+    end
+
+  end
+end

data/lib/passworks/exception.rb

@@ -0,0 +1,5 @@
+module Passworks
+  class Exception < ::StandardError
+  end
+end
+Dir[File.dirname(__FILE__) + "/exceptions/*.rb"].each { |file| require file }

data/lib/passworks/exceptions/bad_gateway.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class BadGateway < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/bad_request.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class BadRequest < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/enhance_your_calm.rb

@@ -0,0 +1,9 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class EnhanceYourCalm < Exception
+    end
+  end
+end
+

data/lib/passworks/exceptions/file_not_found.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class FileNotFound < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/forbidden.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class Forbidden < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/gateway_timeout.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class GatewayTimeout < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/internal_server_error.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class InternalServerError < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/method_not_allowed.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class MethodNotAllowed < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/not_found.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class NotFound < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/not_implemented.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class NotImplemented < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/payment_required.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class PaymentRequired < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/precondition_failed.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class PreconditionFailed < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/service_unavailable.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class ServiceUnavailable < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/unauthorized.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class Unauthorized < Exception
+    end
+  end
+end

data/lib/passworks/exceptions/unprocessable_entity.rb

@@ -0,0 +1,8 @@
+require 'passworks/exception'
+
+module Passworks
+  module Exceptions
+    class UnprocessableEntity < Exception
+    end
+  end
+end

data/lib/passworks/faraday/http_exception_middleware.rb

@@ -0,0 +1,73 @@
+require 'passworks/exception'
+require 'faraday'
+
+module Passworks
+  module Faraday
+    class HttpExceptionMiddleware < ::Faraday::Middleware
+
+      def call(env)
+        @app.call(env).on_complete do |response|
+          case response[:status].to_i
+          when 400
+            raise Passworks::Exceptions::BadRequest, error_400(response)
+          when 401
+            raise Passworks::Exceptions::Unauthorized, error_400(response)
+          when 402
+            raise Passworks::Exceptions::PaymentRequired, error_400(response)
+          when 403
+            raise Passworks::Exceptions::Forbidden, error_400(response)
+          when 404
+            raise Passworks::Exceptions::NotFound, error_400(response)
+          when 405
+            raise Passworks::Exceptions::MethodNotAllowed, error_400(response)
+          when 412
+            raise Passworks::Exceptions::PreconditionFailed, error_400(response)
+          when 420
+            raise Passworks::Exceptions::EnhanceYourCalm, error_400(response)
+          when 422
+            raise Passworks::Exceptions::UnprocessableEntity, error_400(response)
+          when 500
+            raise Passworks::Exceptions::InternalServerError, error_500(response, 'Internal Server Error' , 'The server encountered an unexpected condition which prevented it from fulfilling the request.')
+          when 501
+            raise Passworks::Exceptions::NotImplemented, error_500(response, 'Not Implemented' , 'Current method not implemented.')
+          when 502
+            raise Passworks::Exceptions::BadGateway, error_500(response, 'Bad Gateway', 'The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.')
+          when 503
+            raise Passworks::Exceptions::ServiceUnavailable, error_500(response, 'Service Unavailable', 'The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.')
+          when 504
+            raise Passworks::Exceptions::GatewayTimeout, error_500(response, 'Gateway Timeout', 'The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI.')
+          end
+        end
+      end
+
+      def initialize(app)
+        super
+        @parser = nil
+      end
+
+      private
+        def error_400(response)
+          "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]} - #{error_body(response)}"
+        end
+
+        def error_500(response, short_description, long_description)
+        end
+
+        # {"status_code"=>412, "error_code"=>10103, "message"=>"Asset in use by 1 templates, e.g.: Cocacola"}
+        def error_body(response)
+          body = response[:body]
+          # body gets passed as a string, not sure if it is passed as something else from other spots?
+          if not body.nil? and not body.empty? and body.kind_of?(String)
+            body = ::JSON.parse(body)
+          end
+
+          if body.nil?
+            nil
+          elsif body['message']
+            "(#{body['error_code']}) #{body['message']}"
+          end
+        end
+
+    end
+  end
+end

data/lib/passworks/inflector.rb

@@ -0,0 +1,38 @@
+module Passworks
+  module Inflector
+
+    # Return the singular version of the *curren_collection* name
+    # @return [String] singular version of the current collection name
+    def single_name
+      case collection_name
+      when 'assets'
+        'asset'
+      when 'boarding_passes'
+        'boarding_pass'
+      when 'coupons'
+        'coupon'
+      when 'store_cards'
+        'store_card'
+      when 'event_tickets'
+        'event_ticket'
+      when 'generics'
+        'generic'
+      else
+        raise 'Invalid Collection Name'
+      end
+    end
+
+    # Return resource class based in collection_name and collection_uuid
+    # If collection_name  return [Passworks::AssetResource]
+    # If  collection_uuid == nil return [Passworks::CampaignResource] else return [Passworks::PassResource]
+    def resource_class
+      return Passworks::AssetResource if collection_name == 'assets'
+      if collection_uuid
+        Passworks::PassResource
+      else
+        Passworks::CampaignResource
+      end
+    end
+
+  end
+end

data/lib/passworks/pass_resource.rb

@@ -0,0 +1,40 @@
+require 'passworks/resource'
+
+module Passworks
+
+  # Represents a Pass of a given collection type Coupon, Boarding Pass, Event Ticket, Generic, Store Card
+  #
+  class PassResource < Resource
+
+    # Deletes the current pass
+    # @return [Boolean] True in case the pass is deleted
+    def delete
+      client.delete("#{collection_name}/#{collection_uuid}/passes/#{id}").ok?
+    end
+
+    # Sends a push notification to all clients with this pass installed
+    # @return [Boolean] True in case the pass
+    def push
+      client.post("#{collection_name}/#{collection_uuid}/passes/#{id}/push").ok?
+    end
+
+    # Updates the {PassResource} and returns the updated instance
+    # @return [PassResource] Updated instance
+    def update(data, params={})
+      content = {
+        body: {
+          pass: data
+        }.merge(params)
+      }
+      response  = client.patch("#{collection_name}/#{collection_uuid}/passes/#{id}", content)
+      self.class.new(client, collection_name, response.data)
+    end
+
+    private
+      def collection_uuid
+        @collection_uuid ||= send("#{single_name}_id")
+      end
+
+  end
+
+end