passworks 0.0.1

data/lib/passworks/request.rb

@@ -0,0 +1,49 @@
+module Passworks
+  module Request
+
+    def request(method, path, options={})
+      response = agent.send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(path, options[:query])
+        when :post, :put, :patch
+          request.path = path
+          request.body = options.fetch(:body, {})
+        end
+      end
+      Response.new(self, response)
+    end
+
+    def agent
+      @agent ||= ::Faraday.new(endpoint) do |connection|
+        connection.basic_auth(@api_username, @api_secret)
+        connection.request :multipart
+        connection.request :json
+        connection.response :logger
+        connection.response :json, :content_type => /\bjson$/
+        connection.use Passworks::Faraday::HttpExceptionMiddleware
+        connection.adapter ::Faraday.default_adapter
+      end
+      @agent.headers[:user_agent] = @user_agent
+      # always return the {@agent}
+      @agent
+    end
+
+    def get(url, options={})
+      request(:get, url, options)
+    end
+
+    def post(url, options={})
+      request(:post, url, options)
+    end
+
+    def patch(url, options={})
+      request(:patch, url, options)
+    end
+
+    def delete(url, options={})
+      request(:delete, url, options)
+    end
+
+  end
+end

data/lib/passworks/request_proxy.rb

@@ -0,0 +1,115 @@
+module Passworks
+  class RequestProxy
+
+    include Passworks::Inflector
+
+    # @return [Passworks::Client] fsdfsd fsf sdfsd fsdf
+    attr_reader :client
+
+    # @return [String] Current collection name (ex: assets, campaigns, boarding_passes, coupons, event_tickets)
+    attr_reader :collection_name
+
+    # @return [String] Collection UUID
+    attr_reader :collection_uuid
+
+    def initialize(client, collection_name, collection_uuid=nil, options={})
+      @collection_name = collection_name
+      @collection_uuid = collection_uuid
+      @client          = client
+      @options         = options
+    end
+
+    # Fetch all instances of a given collection (Assests, Boarding Passes, Coupons, Generics and Store Cards)
+    # @param options [Hash] options
+    # @option options [Integer] :per_page Changes the number of results per page
+    # @option options [Integer] :offset 0 The offset to start from
+    # @example Fetching the very first coupon (campaign) without having to pull all the elements first from the server
+    #   client.coupons.all(per_page: 1).first
+    # @example Fetching the very first coupon pass from the first coupon (campaign) without having to pull all the elements first from the server
+    #   client.coupons.all(per_page: 1).first.passes.all(per_page: 1).first
+    # @return [Passworks::CollectionProxy]
+    def all(options={})
+      options = { query: options } unless options.empty?
+      CollectionProxy.new(client, collection_name, collection_uuid, options)
+    end
+
+
+    # Finds a given campaing or passe given the context
+    # @param uuid [String] The campaign or pass UUID
+    # @example Fetching a coupon campaign
+    #   coupon_campaign = client.coupons.find('c3d5fc64-3a43-4d3a-a167-473dfeb1edd3')
+    # @example Fetching a pass for the first coupon campaign
+    #   pass = client.coupons.all(per_page: 1).first.passes.find('c3d5fc64-3a43-4d3a-a167-473dfeb1edd3')
+    # @return [PassResource.new or CampaignResource]
+    def find(uuid)
+      if collection_uuid
+        fetch_url = "#{collection_name}/#{collection_uuid}/passes/#{uuid}"
+      else
+        fetch_url = "#{collection_name}/#{uuid}"
+      end
+      response = client.get(fetch_url)
+      resource_class.new(client, collection_name, response.data)
+    end
+
+    # Creates a campaing instance (Assests, Boarding Passes, Coupons, Generics and Store Cards) or a passe depending of the caller context
+    # @param campaing_or_pass_data [Hash] campaing_or_pass_data Campaign or pass data
+    # @param extra_args [Hash] extra_args Extra arguments to send with the request
+    # @option extra_args [Boolean] merge: (true) Merge passed pass data with the campaign incase you are creating a passe instance.
+    # @example Create a coupon (campaign)
+    #   client.coupons.create({
+    #     name: 'My First Coupon',
+    #     icon_id: 'c3d5fc64-3a43-4d3a-a167-473dfeb1edd3'
+    #   })
+    # @example Create a "empty" passe for the first coupon campaign
+    #   client.coupons.all(per_page: 1).first.passes.create()
+    # @return [Passworks::CampaignResource or Passworks::PassResource] depending of the calling a {Passworks::CampaignResource} or {Passworks::PassResource} is returned.
+    def create(campaing_or_pass_data={}, extra_args={})
+
+      if collection_name.to_s == 'assets' && collection_uuid.nil?
+        raise Passworks::Exceptions::FileNotFound.new("Can't find file #{hash[:file]}") unless hash.has_key?(:file) && File.exists?(hash[:file])
+        hash[:file] = ::Faraday::UploadIO.new(hash[:file], "image/#{hash[:file].split('.').last.downcase}")
+      end
+
+      if collection_uuid
+        content = {
+          body: {
+            'pass' => campaing_or_pass_data
+          }.merge(extra_args)
+        }
+        fetch_url = "#{collection_url}/passes"
+      else
+        content = {
+          body: {
+            single_name.to_sym => campaing_or_pass_data
+          }.merge(extra_args)
+        }
+        fetch_url = collection_url
+      end
+
+      response = client.post(fetch_url, content)
+      resource_class.new(client, collection_name, response.data)
+
+    end
+
+    # Delets a campaing (Assests, Boarding Passes, Coupons, Generics and Store Cards campaign) or a pass instance
+    # @param uuid [String] the UUID of the campaign or pass to delete
+    # @return [Boolean]
+    def delete(uuid)
+      if collection_uuid
+        client.delete("#{collection_name}/#{collection_uuid}/passes/#{uuid}").ok?
+      else
+        client.delete("#{collection_name}/#{uuid}").ok?
+      end
+    end
+
+    # @!visibility private
+    def collection_url
+      if collection_uuid
+        "#{collection_name}/#{collection_uuid}"
+      else
+        collection_name
+      end
+    end
+
+  end
+end

data/lib/passworks/resource.rb

@@ -0,0 +1,18 @@
+require 'passworks/inflector'
+require 'ostruct'
+
+module Passworks
+  class Resource < OpenStruct
+
+    include Passworks::Inflector
+
+    attr_reader :collection_name, :client
+
+    def initialize(client, collection_name, data)
+      @client          = client
+      @collection_name = collection_name
+      super(data)
+    end
+
+  end
+end

data/lib/passworks/response.rb

@@ -0,0 +1,56 @@
+module Passworks
+  class Response
+
+    attr_reader :client, :response, :data
+
+    def initialize(client, response)
+      @client     = client
+      @response   = response
+      @data       = response.body
+    end
+
+    def paginated?
+      (!headers['x-total-pages'].nil?) && (headers['x-total-pages'].to_i > 1)
+    end
+
+    def next_page?
+      !headers['x-next-page'].nil?
+    end
+
+    def next_page
+      headers['x-next-page'].to_i if next_page?
+    end
+
+    def previous_page?
+      !headers['x-prev-page'].nil?
+    end
+
+    def previous_page
+      headers['x-prev-page'].to_i if previous_page?
+    end
+
+    def http_status
+      @response[:status].to_i
+    end
+
+    def ok?
+      (http_status >= 200) && (http_status < 300)
+    end
+
+    def headers
+      @response.env[:response_headers] || {}
+    end
+
+    def size
+      return headers['x-total'].to_i unless headers['x-total'].nil?
+      return data.size if data.is_a?(Array)
+      return 0
+    end
+
+    def next_page_url
+      return nil unless next_page?
+      params = { page: next_page }
+    end
+
+  end
+end

data/lib/passworks/version.rb

@@ -0,0 +1,3 @@
+module Passworks
+  VERSION = "0.0.1"
+end

data/passworks.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'passworks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "passworks"
+  spec.version       = Passworks::VERSION
+  spec.authors       = ["Luis Mendes", "Miguel Verissimo"]
+  spec.email         = ["luis@passworks.io", "miguel@passworks.io"]
+  spec.summary       = %q{Passworks API client}
+  spec.description   = %q{Provides a simple interface to Passworks API}
+  spec.homepage      = "https://www.passworks.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_dependency 'faraday_middleware', '~> 0.9.1'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: passworks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Luis Mendes
+- Miguel Verissimo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: pry
+  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: pry-byebug
+  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: 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: webmock
+  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: vcr
+  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'
+description: Provides a simple interface to Passworks API
+email:
+- luis@passworks.io
+- miguel@passworks.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/passworks.rb
+- lib/passworks/asset_resource.rb
+- lib/passworks/campaign_resource.rb
+- lib/passworks/client.rb
+- lib/passworks/collection_proxy.rb
+- lib/passworks/configuration.rb
+- lib/passworks/exception.rb
+- lib/passworks/exceptions/bad_gateway.rb
+- lib/passworks/exceptions/bad_request.rb
+- lib/passworks/exceptions/enhance_your_calm.rb
+- lib/passworks/exceptions/file_not_found.rb
+- lib/passworks/exceptions/forbidden.rb
+- lib/passworks/exceptions/gateway_timeout.rb
+- lib/passworks/exceptions/internal_server_error.rb
+- lib/passworks/exceptions/method_not_allowed.rb
+- lib/passworks/exceptions/not_found.rb
+- lib/passworks/exceptions/not_implemented.rb
+- lib/passworks/exceptions/payment_required.rb
+- lib/passworks/exceptions/precondition_failed.rb
+- lib/passworks/exceptions/service_unavailable.rb
+- lib/passworks/exceptions/unauthorized.rb
+- lib/passworks/exceptions/unprocessable_entity.rb
+- lib/passworks/faraday/http_exception_middleware.rb
+- lib/passworks/inflector.rb
+- lib/passworks/pass_resource.rb
+- lib/passworks/request.rb
+- lib/passworks/request_proxy.rb
+- lib/passworks/resource.rb
+- lib/passworks/response.rb
+- lib/passworks/version.rb
+- passworks.gemspec
+homepage: https://www.passworks.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Passworks API client
+test_files: []