ohanakapa 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6afd9df44e4e14d0effab2bd786c6403b0bacb8d
+  data.tar.gz: 67e060430cb70d065cb082eecc7fd4d843831417
+SHA512:
+  metadata.gz: 6cc26a543d2d073213bebb5d47efeb957670feb0e37c7b4e28dcc6c4bca1d534b402ac5027f8e4fede437ebe5b5f42c947d17ec4645470baa1a4d10ce634f5f6
+  data.tar.gz: 89fefdb5dec09c5116a98ba899c6e990e75d04c591b1c9d9caab39265d1c9ba75280a50a15307800911e9b130c8f34cf5df8f9e4f67c6b0a0f836596a6fd25ee

data/lib/ohanakapa.rb

@@ -0,0 +1,33 @@
+require 'ohanakapa/client'
+require 'ohanakapa/default'
+
+# Ruby toolkit for the Ohana API
+module Ohanakapa
+
+	class << self
+    include Ohanakapa::Configurable
+
+	  # API client based on configured options {Configurable}
+    #
+    # @return [Ohanakapa::Client] API wrapper
+    def client
+      @client = Ohanakapa::Client.new(options) unless defined?(@client) && @client.same_options?(options)
+      @client
+    end
+
+    # @private
+    def respond_to_missing?(method_name, include_private=false); client.respond_to?(method_name, include_private); end if RUBY_VERSION >= "1.9"
+    # @private
+    def respond_to?(method_name, include_private=false); client.respond_to?(method_name, include_private) || super; end if RUBY_VERSION < "1.9"
+
+  	private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+	end
+end
+
+Ohanakapa.setup

data/lib/ohanakapa/arguments.rb

@@ -0,0 +1,14 @@
+module Ohanakapa
+
+  # Extracts options from method arguments
+  # @private
+  class Arguments < Array
+    attr_reader :options
+
+    def initialize(args)
+      @options = args.last.is_a?(::Hash) ? args.pop : {}
+      super(args)
+    end
+
+  end
+end

data/lib/ohanakapa/authentication.rb

@@ -0,0 +1,25 @@
+module Ohanakapa
+
+  # Authentication methods for {Ohanakapa::Client}
+  module Authentication
+
+    # Indicates if the client has Application
+    # api_token credentials to make anonymous
+    # requests at a higher rate limit
+    #
+    # @see http://ohanapi.herokuapp.com/api/docs
+    # @return [Boolean]
+    def application_authenticated?
+      !!application_authentication
+    end
+
+    private
+
+    def application_authentication
+      if @api_token
+        { :api_token => @api_token }
+      end
+    end
+
+  end
+end

data/lib/ohanakapa/client.rb

@@ -0,0 +1,226 @@
+require 'sawyer'
+require 'ohanakapa/arguments'
+require 'ohanakapa/configurable'
+require 'ohanakapa/authentication'
+require 'ohanakapa/rate_limit'
+require 'ohanakapa/client/organizations'
+require 'ohanakapa/client/locations'
+require 'ohanakapa/client/categories'
+require 'ohanakapa/client/keywords'
+require 'ohanakapa/client/search'
+require 'ohanakapa/client/rate_limit'
+
+module Ohanakapa
+
+  # Client for the Ohana API
+  #
+  # @see http://ohanapi.herokuapp.com/api/docs
+  class Client
+
+    include Ohanakapa::Authentication
+    include Ohanakapa::Configurable
+    include Ohanakapa::Client::Organizations
+    include Ohanakapa::Client::Locations
+    include Ohanakapa::Client::Categories
+    include Ohanakapa::Client::Keywords
+    include Ohanakapa::Client::Search
+    include Ohanakapa::Client::RateLimit
+
+    # Header keys that can be passed in options hash to {#get},{#head}
+    CONVENIENCE_HEADERS = Set.new [:accept]
+
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      Ohanakapa::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Ohanakapa.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    # 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
+
+    # Text representation of the client, masking tokens and passwords
+    #
+    # @return [String]
+    def inspect
+      inspected = super
+
+      # Only show last 4 of api token
+      if @api_token
+        inspected = inspected.gsub! @api_token, "#{'*'*32}#{@api_token[32..-1]}"
+      end
+
+      inspected
+    end
+
+    # 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
+    # @return [Sawyer::Resource]
+    def paginate(url, options = {})
+      opts = parse_query_and_convenience_headers(options.dup)
+      # if @auto_paginate
+      #   opts[:query][:per_page] ||=  @per_page || (@auto_paginate ? 100 : nil)
+      # end
+
+      data = request(:get, url, opts)
+
+      if @auto_paginate && data.is_a?(Array)
+        while @last_response.rels[:next] && rate_limit.remaining > 0
+          @last_response = @last_response.rels[:next].get
+          data.concat(@last_response.data) if @last_response.data.is_a?(Array)
+        end
+
+      end
+
+      data
+    end
+
+    # Hypermedia agent for the Ohana API
+    #
+    # @return [Sawyer::Agent]
+    def agent
+      @agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
+        http.headers[:accept] = default_media_type
+        http.headers[:user_agent] = user_agent
+        if application_authenticated?
+          http.headers["X-Api-Token"] = @api_token
+        end
+      end
+    end
+
+    # Fetch the root resource for the API
+    #
+    # @return [Sawyer::Resource]
+    def root
+      agent.start.data
+    end
+
+    # Response for last HTTP request
+    #
+    # @return [Sawyer::Response]
+    def last_response
+      @last_response
+    end
+
+    private
+
+    def request(method, path, data)
+      options = {}
+      options[:query]   = data.delete(:query) || {}
+      options[:headers] = data.delete(:headers) || {}
+
+      if application_authenticated?
+        options[:query].merge! application_authentication
+      end
+      if accept = data.delete(:accept)
+        options[:headers][:accept] = accept
+      end
+
+      @last_response = response = agent.call(method, URI.encode(path), 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 Ohanakapa::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
+      opts[:faraday] = Faraday.new(conn_opts)
+
+      opts
+    end
+
+    def parse_query_and_convenience_headers(options)
+      headers = options.fetch(:headers, {})
+      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/ohanakapa/client/categories.rb

@@ -0,0 +1,42 @@
+module Ohanakapa
+  class Client
+
+    # Methods for the Categories endpoint
+    #
+    # @see http://ohanapi.herokuapp.com/api/docs
+    module Categories
+
+      # List all categories
+      #
+      # This provides a dump of every category, in the order that they
+      # were uploaded to the Ohana DB.
+      #
+      # @see http://ohanapi.herokuapp.com/api/docs#!/api/GET-api-categories---format-_get_0
+      #
+      # @return [Array<Sawyer::Resource>] List of Categories.
+      #
+      # @example
+      #   Ohanakapa.categories
+      # @example
+      #   Ohanakapa.cats
+      def categories(options={})
+        paginate "categories", options
+      end
+      alias :cats :categories
+
+      # Replace all categories for a Service
+      #
+      # @param service_id [String] Number ID of the service
+      # @param cat_ids [Array] An array of category IDs to use as replacement
+      # @return [<Sawyer::Resource>] The updated service
+      # @see http://ohanapi.herokuapp.com/api/docs
+      # @example Replace categories for service with ID '521d339f1974fcdb2b00573e'
+      #   Ohanakapa.replace_all_categories("521d339f1974fcdb2b00573e", ['52280f5c1edd37edff000001', '52280f5c1edd37edff000003'])
+      def replace_all_categories(service_id, cat_ids)
+        put "services/#{service_id}/categories", :query => { :category_ids => cat_ids }
+      end
+
+
+    end
+  end
+end

data/lib/ohanakapa/client/keywords.rb

@@ -0,0 +1,24 @@
+module Ohanakapa
+  class Client
+
+    # Methods for adding Keywords to a service
+    #
+    # @see http://ohanapi.herokuapp.com/api/docs
+    module Keywords
+
+      # Add keywords to a Service
+      #
+      # @param service_id [String] Number ID of the service
+      # @param keywords [Array] An array of keywords to use as replacement
+      # @return [<Sawyer::Resource>] The updated service
+      # @see http://ohanapi.herokuapp.com/api/docs
+      # @example Add keywords to service with ID '521d339f1974fcdb2b00573e'
+      #   Ohanakapa.add_keywords_to_a_service("521d339f1974fcdb2b00573e", ['testing', 'api'])
+      def add_keywords_to_a_service(service_id, keywords)
+        post "services/#{service_id}/keywords", :query => { :keywords => keywords }
+      end
+
+
+    end
+  end
+end

data/lib/ohanakapa/client/locations.rb

@@ -0,0 +1,67 @@
+module Ohanakapa
+  class Client
+
+    # Methods for the Locations API
+    #
+    # @see http://ohanapi.herokuapp.com/api/docs
+    module Locations
+
+      # List all locations
+      #
+      # This provides a dump of every location, in the order that they
+      # were uploaded to the Ohana DB.
+      #
+      # @see http://ohanapi.herokuapp.com/api/docs#!/api/GET-api-locations---format-_get_0
+      #
+      # @return [Array<Sawyer::Resource>] List of Locations.
+      #
+      # @example
+      #   Ohanakapa.locations
+      # @example
+      #   Ohanakapa.locs
+      def locations(options={})
+        paginate "locations", options
+      end
+      alias :locs :locations
+
+      # Get a single location based on its ID
+      # @see http://ohanapi.herokuapp.com/api/docs#!/api/GET-api-locations--id---format-_get_1
+      #
+      # @param id [String] location ID.
+      # @return [Sawyer::Resource]
+      # @example
+      #   Ohanakapa.location('519c44065634241897000023')
+      # @example
+      #   Ohanakapa.loc('519c44065634241897000023')
+      def location(id)
+        get("locations/#{id}")
+      end
+      alias :loc :location
+
+      # Get nearby locations to an location, based on its ID
+      #
+      # @param id [String] location ID.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Float] :radius
+      # @return [Sawyer::Resource] Hash representing nearby locations.
+      # @example
+      #   Ohanakapa.nearby('519c44065634241897000023', :radius => 0.5)
+      def nearby(id, options={})
+        get("locations/#{id}/nearby", options)
+      end
+
+      # Update a location
+      #
+      # @param id [String] location ID.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :kind
+      # @return [Sawyer::Resource]
+      # @example
+      #   Ohanakapa.location("521d33a01974fcdb2b0036a9", :kind => "entertainment")
+      def update_location(id, options)
+        put "locations/#{id}", :query => options
+      end
+
+    end
+  end
+end