karatekit 0.1.0

data/lib/karatekit/client.rb

@@ -0,0 +1,78 @@
+require 'karatekit/connection'
+require 'karatekit/warnable'
+require 'karatekit/arguments'
+require 'karatekit/configurable'
+require 'karatekit/authentication'
+require 'karatekit/rate_limit'
+
+require 'karatekit/client/locations'
+require 'karatekit/client/products'
+require 'karatekit/client/sessions'
+require 'karatekit/client/events'
+require 'karatekit/client/event_details'
+require 'karatekit/client/event_parts'
+require 'karatekit/client/posts'
+require 'karatekit/client/instructors'
+require 'karatekit/client/instructor_details'
+require 'karatekit/client/instructor_groups'
+require 'karatekit/client/instructor_group_members'
+require 'karatekit/client/rate_limit'
+
+module Karatekit
+
+  # Client for the kampfsport.center API
+  #
+  # @see https://developer.kampfsport.center
+  class Client
+
+    include Karatekit::Authentication
+    include Karatekit::Configurable
+    include Karatekit::Connection
+    include Karatekit::Warnable
+
+    include Karatekit::Client::Locations
+    include Karatekit::Client::Products
+    include Karatekit::Client::Sessions
+    include Karatekit::Client::Events
+    include Karatekit::Client::EventDetails
+    include Karatekit::Client::EventParts
+    include Karatekit::Client::Posts
+    include Karatekit::Client::Instructors
+    include Karatekit::Client::InstructorDetails
+    include Karatekit::Client::InstructorGroups
+    include Karatekit::Client::InstructorGroupMembers
+    include Karatekit::Client::RateLimit
+
+    # Header keys that can be passed in options hash to {#get},{#head}
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      Karatekit::Configurable.keys.each do |key|
+        value = options.key?(key) ? options[key] : Karatekit.instance_variable_get(:"@#{key}")
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+
+    # Text representation of the client, masking tokens and passwords
+    #
+    # @return [String]
+    def inspect
+      inspected = super
+
+      if @access_token
+        inspected = inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}"
+      end
+
+      inspected
+    end
+
+    # Set OAuth access token for authentication
+    #
+    # @param value [String] 40 character kampfsport.center OAuth access token
+    def access_token=(value)
+      reset_agent
+      @access_token = value
+    end
+  end
+end

data/lib/karatekit/configurable.rb

@@ -0,0 +1,80 @@
+module Karatekit
+
+  # Configuration options for {Client}, defaulting to values
+  # in {Default}
+  module Configurable
+    # @!attribute [w] access_token
+    #   @see https://developer.github.com/v3/oauth/
+    #   @return [String] OAuth2 access token for authentication
+    # @!attribute api_endpoint
+    #   @return [String] Base URL for API requests. default: https://api.github.com/
+    # @!attribute auto_paginate
+    #   @return [Boolean] Auto fetch next page of results until rate limit reached
+    # @!attribute connection_options
+    #   @see https://github.com/lostisland/faraday
+    #   @return [Hash] Configure connection options for Faraday
+    # @!attribute middleware
+    #   @see https://github.com/lostisland/faraday
+    #   @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
+    # @!attribute per_page
+    #   @return [String] Configure page size for paginated results. API default: 30
+    # @!attribute user_agent
+    #   @return [String] Configure User-Agent header for requests.
+
+    attr_accessor :access_token, :auto_paginate,
+                  :connection_options, :default_media_type,
+                  :middleware,
+                  :per_page, :user_agent
+    attr_writer :api_endpoint
+
+    class << self
+
+      # List of configurable keys for {Karatekit::Client}
+      # @return [Array] of option keys
+      def keys
+        @keys ||= [
+          :access_token,
+          :api_endpoint,
+          :default_media_type,
+          :auto_paginate,
+          :connection_options,
+          :middleware,
+          :per_page,
+          :user_agent,
+        ]
+      end
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # Reset configuration options to default values
+    def reset!
+      Karatekit::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Karatekit::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+    # Compares client options to a Hash of requested options
+    #
+    # @param opts [Hash] Options to compare with current client options
+    # @return [Boolean]
+    def same_options?(opts)
+      opts.hash == options.hash
+    end
+
+    def api_endpoint
+      File.join(@api_endpoint, "")
+    end
+
+    private
+
+    def options
+      Hash[Karatekit::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+  end
+end

data/lib/karatekit/connection.rb

@@ -0,0 +1,191 @@
+require 'sawyer'
+require 'karatekit/authentication'
+module Karatekit
+
+  # Network layer for API clients.
+  module Connection
+
+    include Karatekit::Authentication
+
+    # Header keys that can be passed in options hash to {#get},{#head}
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def get(url, options = {})
+      request :get, url, parse_query_and_convenience_headers(options)
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def post(url, options = {})
+      request :post, url, options
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def put(url, options = {})
+      request :put, url, options
+    end
+
+    # Make a HTTP PATCH request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def patch(url, options = {})
+      request :patch, url, options
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def delete(url, options = {})
+      request :delete, url, options
+    end
+
+    # Make a HTTP HEAD request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def head(url, options = {})
+      request :head, url, parse_query_and_convenience_headers(options)
+    end
+
+    # Make one or more HTTP GET requests, optionally fetching
+    # the next page of results from URL in Link response header based
+    # on value in {#auto_paginate}.
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @param block [Block] Block to perform the data concatination of the
+    #   multiple requests. The block is called with two parameters, the first
+    #   contains the contents of the requests so far and the second parameter
+    #   contains the latest response.
+    # @return [Sawyer::Resource]
+    def paginate(url, options = {}, &block)
+      opts = parse_query_and_convenience_headers(options)
+      if @auto_paginate || @per_page
+        opts[:query][:per_page] ||=  @per_page || (@auto_paginate ? 100 : nil)
+      end
+
+      data = request(:get, url, opts.dup)
+
+      if @auto_paginate
+        while @last_response.rels[:next] && rate_limit.remaining > 0
+          @last_response = @last_response.rels[:next].get(:headers => opts[:headers])
+          if block_given?
+            yield(data, @last_response)
+          else
+            data.concat(@last_response.data) if @last_response.data.is_a?(Array)
+          end
+        end
+
+      end
+
+      data
+    end
+
+    # Hypermedia agent for the kampfsport.center API
+    #
+    # @return [Sawyer::Agent]
+    def agent
+      @agent ||= Sawyer::Agent.new(endpoint, sawyer_options) do |http|
+        http.headers[:accept] = default_media_type
+        http.headers[:content_type] = "application/json"
+        http.headers[:user_agent] = user_agent
+        http.authorization 'Token', @access_token
+      end
+    end
+
+    # Fetch the root resource for the API
+    #
+    # @return [Sawyer::Resource]
+    def root
+      get "/"
+    end
+
+    # Response for last HTTP request
+    #
+    # @return [Sawyer::Response]
+    def last_response
+      @last_response if defined? @last_response
+    end
+
+    protected
+
+    def endpoint
+      api_endpoint
+    end
+
+    private
+
+    def reset_agent
+      @agent = nil
+    end
+
+    def request(method, path, data, options = {})
+      if data.is_a?(Hash)
+        options[:query]   = data.delete(:query) || {}
+        options[:headers] = data.delete(:headers) || {}
+        if accept = data.delete(:accept)
+          options[:headers][:accept] = accept
+        end
+      end
+
+      @last_response = response = agent.call(method, Addressable::URI.parse(path.to_s).normalize.to_s, data, options)
+      response.data
+    end
+
+    # Executes the request, checking if it was successful
+    #
+    # @return [Boolean] True on success, false otherwise
+    def boolean_from_response(method, path, options = {})
+      request(method, path, options)
+      @last_response.status == 204
+    rescue Karatekit::NotFound
+      false
+    end
+
+    def sawyer_options
+      opts = {
+        :links_parser => Sawyer::LinkParsers::Simple.new
+      }
+      conn_opts = @connection_options
+      conn_opts[:builder] = @middleware if @middleware
+      conn_opts[:proxy] = @proxy if @proxy
+      conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
+      opts[:faraday] = Faraday.new(conn_opts)
+
+      opts
+    end
+
+    def parse_query_and_convenience_headers(options)
+      options = options.dup
+      headers = options.delete(:headers) { Hash.new }
+      CONVENIENCE_HEADERS.each do |h|
+        if header = options.delete(h)
+          headers[h] = header
+        end
+      end
+      query = options.delete(:query)
+      opts = {:query => options}
+      opts[:query].merge!(query) if query && query.is_a?(Hash)
+      opts[:headers] = headers unless headers.empty?
+
+      opts
+    end
+  end
+end

data/lib/karatekit/default.rb

@@ -0,0 +1,97 @@
+# require 'karatekit/middleware/follow_redirects'
+require 'karatekit/response/raise_error'
+# require 'karatekit/response/feed_parser'
+require 'karatekit/version'
+
+module Karatekit
+
+  # Default configuration options for {Client}
+  module Default
+
+    # Default API endpoint
+    API_ENDPOINT = "https://api.kampfsport.center".freeze
+
+    # Default User Agent header string
+    USER_AGENT   = "Karatekit Ruby Gem #{Karatekit::VERSION}".freeze
+
+    # Default media type
+    MEDIA_TYPE   = "application/json".freeze
+
+    # In Faraday 0.9, Faraday::Builder was renamed to Faraday::RackBuilder
+    RACK_BUILDER_CLASS = defined?(Faraday::RackBuilder) ? Faraday::RackBuilder : Faraday::Builder
+
+    # Default Faraday middleware stack
+    MIDDLEWARE = RACK_BUILDER_CLASS.new do |builder|
+      builder.use Faraday::Request::Retry, exceptions: [Karatekit::ServerError]
+      # builder.use Karatekit::Middleware::FollowRedirects
+      builder.use Karatekit::Response::RaiseError
+      # builder.use Karatekit::Response::FeedParser
+      builder.adapter Faraday.default_adapter
+    end
+
+    class << self
+
+      # Configuration options
+      # @return [Hash]
+      def options
+        Hash[Karatekit::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      # Default access token from ENV
+      # @return [String]
+      def access_token
+        ENV['KARATEKIT_ACCESS_TOKEN']
+      end
+
+      # Default API endpoint from ENV or {API_ENDPOINT}
+      # @return [String]
+      def api_endpoint
+        ENV['KARATEKIT_API_ENDPOINT'] || API_ENDPOINT
+      end
+
+      # Default pagination preference from ENV
+      # @return [String]
+      def auto_paginate
+        ENV['KARATEKIT_AUTO_PAGINATE']
+      end
+
+      # Default options for Faraday::Connection
+      # @return [Hash]
+      def connection_options
+        {
+          :headers => {
+            :accept => default_media_type,
+            :user_agent => user_agent
+          }
+        }
+      end
+
+      # Default media type from {MEDIA_TYPE}
+      # @return [String]
+      def default_media_type
+        MEDIA_TYPE
+      end
+
+      # Default middleware stack for Faraday::Connection
+      # from {MIDDLEWARE}
+      # @return [Faraday::RackBuilder or Faraday::Builder]
+      def middleware
+        MIDDLEWARE
+      end
+
+      # Default pagination page size from ENV
+      # @return [Integer] Page size
+      def per_page
+        page_size = ENV['KARATEKIT_PER_PAGE']
+
+        page_size.to_i if page_size
+      end
+
+      # Default User-Agent header string from ENV or {USER_AGENT}
+      # @return [String]
+      def user_agent
+        ENV['KARATEKIT_USER_AGENT'] || USER_AGENT
+      end
+    end
+  end
+end

data/lib/karatekit/error.rb

@@ -0,0 +1,244 @@
+module Karatekit
+  # Custom error class for rescuing from all kampfsport.center errors
+  class Error < StandardError
+
+    # Returns the appropriate Karatekit::Error subclass based
+    # on status and response message
+    #
+    # @param [Hash] response HTTP response
+    # @return [Karatekit::Error]
+    def self.from_response(response)
+      status  = response[:status].to_i
+      body    = response[:body].to_s
+      headers = response[:response_headers]
+
+      if klass =  case status
+                  when 400      then Karatekit::BadRequest
+                  when 401      then error_for_401(headers)
+                  when 403      then error_for_403(body)
+                  when 404      then error_for_404(body)
+                  when 405      then Karatekit::MethodNotAllowed
+                  when 406      then Karatekit::NotAcceptable
+                  when 409      then Karatekit::Conflict
+                  when 415      then Karatekit::UnsupportedMediaType
+                  when 422      then Karatekit::UnprocessableEntity
+                  when 451      then Karatekit::UnavailableForLegalReasons
+                  when 400..499 then Karatekit::ClientError
+                  when 500      then Karatekit::InternalServerError
+                  when 501      then Karatekit::NotImplemented
+                  when 502      then Karatekit::BadGateway
+                  when 503      then Karatekit::ServiceUnavailable
+                  when 500..599 then Karatekit::ServerError
+                  end
+        klass.new(response)
+      end
+    end
+
+    def initialize(response=nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    # Documentation URL returned by the API for some errors
+    #
+    # @return [String]
+    def documentation_url
+      data[:documentation_url] if data.is_a? Hash
+    end
+
+    # Returns most appropriate error for 401 HTTP status code
+    # @private
+    def self.error_for_401(headers)
+      Karatekit::Unauthorized
+    end
+
+    # Returns most appropriate error for 403 HTTP status code
+    # @private
+    def self.error_for_403(body)
+      if body =~ /rate limit exceeded/i
+        Karatekit::TooManyRequests
+      elsif body =~ /login attempts exceeded/i
+        Karatekit::TooManyLoginAttempts
+      elsif body =~ /abuse/i
+        Karatekit::AbuseDetected
+      elsif body =~ /email address must be verified/i
+        Karatekit::UnverifiedEmail
+      elsif body =~ /account was suspended/i
+        Karatekit::AccountSuspended
+      else
+        Karatekit::Forbidden
+      end
+    end
+
+    # Return most appropriate error for 404 HTTP status code
+    # @private
+    def self.error_for_404(body)
+      Karatekit::NotFound
+    end
+
+    # Array of validation errors
+    # @return [Array<Hash>] Error info
+    def errors
+      if data && data.is_a?(Hash)
+        data[:errors] || []
+      else
+        []
+      end
+    end
+
+    # Status code returned by the kampfsport.center server.
+    #
+    # @return [Integer]
+    def response_status
+      @response[:status]
+    end
+
+    # Headers returned by the kampfsport.center server.
+    #
+    # @return [Hash]
+    def response_headers
+      @response[:response_headers]
+    end
+
+    # Body returned by the kampfsport.center server.
+    #
+    # @return [String]
+    def response_body
+      @response[:body]
+    end
+
+    private
+
+    def data
+      @data ||=
+        if (body = @response[:body]) && !body.empty?
+          if body.is_a?(String) &&
+            @response[:response_headers] &&
+            @response[:response_headers][:content_type] =~ /json/
+
+            Sawyer::Agent.serializer.decode(body)
+          else
+            body
+          end
+        else
+          nil
+        end
+    end
+
+    def response_message
+      case data
+      when Hash
+        data[:message]
+      when String
+        data
+      end
+    end
+
+    def response_error
+      "Error: #{data[:error]}" if data.is_a?(Hash) && data[:error]
+    end
+
+    def response_error_summary
+      return nil unless data.is_a?(Hash) && !Array(data[:errors]).empty?
+
+      summary = "\nError summary:\n"
+      summary << data[:errors].map do |error|
+        if error.is_a? Hash
+          error.map { |k,v| "  #{k}: #{v}" }
+        else
+          "  #{error}"
+        end
+      end.join("\n")
+
+      summary
+    end
+
+    def build_error_message
+      return nil if @response.nil?
+
+      message =  "#{@response[:method].to_s.upcase} "
+      message << redact_url(@response[:url].to_s) + ": "
+      message << "#{@response[:status]} - "
+      message << "#{response_message}" unless response_message.nil?
+      message << "#{response_error}" unless response_error.nil?
+      message << "#{response_error_summary}" unless response_error_summary.nil?
+      message << " // See: #{documentation_url}" unless documentation_url.nil?
+      message
+    end
+
+    def redact_url(url_string)
+      %w[client_secret access_token].each do |token|
+        url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)") if url_string.include? token
+      end
+      url_string
+    end
+  end
+
+  # Raised on errors in the 400-499 range
+  class ClientError < Error; end
+
+  # Raised when kampfsport.center returns a 400 HTTP status code
+  class BadRequest < ClientError; end
+
+  # Raised when kampfsport.center returns a 401 HTTP status code
+  class Unauthorized < ClientError; end
+
+  # Raised when kampfsport.center returns a 403 HTTP status code
+  class Forbidden < ClientError; end
+
+  # Raised when kampfsport.center returns a 403 HTTP status code
+  # and body matches 'rate limit exceeded'
+  class TooManyRequests < Forbidden; end
+
+  # Raised when kampfsport.center returns a 403 HTTP status code
+  # and body matches 'login attempts exceeded'
+  class TooManyLoginAttempts < Forbidden; end
+
+  # Raised when kampfsport.center returns a 403 HTTP status code
+  # and body matches 'abuse'
+  class AbuseDetected < Forbidden; end
+
+  # Raised when kampfsport.center returns a 403 HTTP status code
+  # and body matches 'email address must be verified'
+  class UnverifiedEmail < Forbidden; end
+
+  # Raised when kampfsport.center returns a 403 HTTP status code
+  # and body matches 'account was suspended'
+  class AccountSuspended < Forbidden; end
+
+  # Raised when kampfsport.center returns a 404 HTTP status code
+  class NotFound < ClientError; end
+
+  # Raised when kampfsport.center returns a 405 HTTP status code
+  class MethodNotAllowed < ClientError; end
+
+  # Raised when kampfsport.center returns a 406 HTTP status code
+  class NotAcceptable < ClientError; end
+
+  # Raised when kampfsport.center returns a 409 HTTP status code
+  class Conflict < ClientError; end
+
+  # Raised when kampfsport.center returns a 414 HTTP status code
+  class UnsupportedMediaType < ClientError; end
+
+  # Raised when kampfsport.center returns a 422 HTTP status code
+  class UnprocessableEntity < ClientError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when kampfsport.center returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when kampfsport.center returns a 501 HTTP status code
+  class NotImplemented < ServerError; end
+
+  # Raised when kampfsport.center returns a 502 HTTP status code
+  class BadGateway < ServerError; end
+
+  # Raised when kampfsport.center returns a 503 HTTP status code
+  class ServiceUnavailable < ServerError; end
+
+  # Raised when client fails to provide valid Content-Type
+  class MissingContentType < ArgumentError; end
+end