turba_kit 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 032cbfe91ba7465a1f61586f8147bf6745c64bdc
+  data.tar.gz: ff76c291e3c7ef08df77e3dd9c0a3b700d2f7001
+SHA512:
+  metadata.gz: a713192585164fe8fba1633340d652235e409e23956ab031ef0f0498893487d56ad2b80b00035efd6c3f5fb1da45c7dc5458537f43cea89f6f738cec28969a3c
+  data.tar.gz: 9f2369295552e66e3cd1ee5be8538f38d9469382dc884eea2a2fe84ac464cea72ac755e0e7f12d8ee001dee61b1ef73b8b94c451a7d0ce8d7fb2d98ab9182883

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'faraday'
+gem 'sawyer'
+
+group :test do
+  gem 'webmock'
+  gem 'vcr'
+  gem 'turn'
+  gem 'rake'
+  gem 'rspec', '~> 3.0.0.beta2'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joffrey JAFFEUX
+
+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 @@
+# TurbaKit

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+namespace :doc do
+  begin
+    require 'yard'
+    YARD::Rake::YardocTask.new do |task|
+      task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
+      task.options = [
+        '--output-dir', 'doc/yard',
+        '--markup', 'markdown',
+      ]
+    end
+  rescue LoadError
+  end
+end

data/lib/turba_kit/arguments.rb

@@ -0,0 +1,14 @@
+module TurbaKit
+
+  # 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/turba_kit/authentication.rb

@@ -0,0 +1,10 @@
+module TurbaKit
+
+  # Authentication methods for {TurbaKit::Client}
+  module Authentication
+
+    def api_key_authenticated?
+      !!@api_key
+    end
+  end
+end

data/lib/turba_kit/client/categories.rb

@@ -0,0 +1,41 @@
+module TurbaKit
+  class Client
+    module Categories
+      def category(id_or_uri_id, *args)
+        get("categories/#{id_or_uri_id}?#{query_string(args)}")[:category]
+      end
+
+      def categories(*args)
+        get("categories?#{query_string(args)}")[:categories]
+      end
+
+      def create_category(params)
+        params = {category: params}
+        post("categories", options.merge(params))[:category]
+      end
+
+      def delete_category(id_or_uri_id)
+        boolean_from_response :delete, "categories/#{id_or_uri_id}", options
+      end
+
+      def search_category(query, *args)
+        get("categories?q=#{query}&#{query_string(args)}")[:categories]
+      end
+
+      # Update a category
+      #
+      # @param id_or_uri_id [String] ID of the category
+      # @param params [Hash] A customizable set of params.
+      # @option category_params [String] :title Category title.
+      # @option category_params [String] :url Category URL.
+      # @option category_params [String] :country_code Category country code.
+      # @return [Sawyer::Resource] The updated category
+      # @see https://github.com/turba-webservices/api-documentation/blob/master/v2/sections/categories.md#update-category
+      # @example Change the title of Category xxxxxx
+      #   TurbaKit.update_issue("xxxxxx", {title: "A new title"})
+      def update_category(id_or_uri_id, category_params = {})
+        put("categories/#{id_or_uri_id}", options.merge({category: category_params}))[:category]
+      end
+    end
+  end
+end

data/lib/turba_kit/client/checkins.rb

@@ -0,0 +1,14 @@
+module TurbaKit
+  class Client
+    module Checkins
+      def create_wait_checkin(service_id, wait)
+        post("services/#{service_id}/checkins?wait=#{wait}")
+      end
+
+      def recent_checkins(limit = 5, since)
+        since ||= 10.days.ago
+        get("checkins?limit=#{limit}&since=#{since}")
+      end
+    end
+  end
+end

data/lib/turba_kit/client/comments.rb

@@ -0,0 +1,9 @@
+module TurbaKit
+  class Client
+    module Comments
+      def comments(page_url, domain, shortname, disqus_api_key)
+        get("comments?disqus_api_key=#{disqus_api_key}&url=#{page_url}&domain=#{domain}&disqus_shortname=#{shortname}")[:comments]
+      end
+    end
+  end
+end

data/lib/turba_kit/client/contents.rb

@@ -0,0 +1,26 @@
+module TurbaKit
+  class Client
+    module Contents
+      def service_content(service_id, content_id)
+        get("services/#{service_id}/contents/#{content_id}")[:content]
+      end
+
+      def service_contents(service_id)
+        get("services/#{service_id}/contents")[:contents]
+      end
+
+      def create_content(service_id, params, options = {})
+        # params = {type: type}
+        post("services/#{service_id}/contents", {content: options.merge(params)})[:content]
+      end
+
+      def update_content(service_id, content_id, *args)
+        put("services/#{service_id}/contents/#{content_id}", {content: options.merge(args[0])})[:content]
+      end
+
+      def delete_content(service_id, content_id)
+        boolean_from_response :delete, "services/#{service_id}/contents/#{content_id}", options
+      end
+    end
+  end
+end

data/lib/turba_kit/client/countries.rb

@@ -0,0 +1,14 @@
+module TurbaKit
+  class Client
+    module Countries
+      def country(country_code)
+        countries = get("countries")[:countries]
+        countries.select{|k, v| k[:country_code] == country_code}.first
+      end
+
+      def countries
+        get("countries")[:countries]
+      end
+    end
+  end
+end

data/lib/turba_kit/client/crowd_table.rb

@@ -0,0 +1,25 @@
+module TurbaKit
+  class Client
+    module CrowdTable
+      def service_crowd_table(service_id)
+        get("services/#{service_id}/crowd_table")[:crowd_table]
+      end
+
+      def create_crowd_table(service_id, params, options = {})
+        post("services/#{service_id}/crowd_table", {crowd_table: options.merge(params)})[:crowd_table]
+      end
+
+      def update_crowd_table(service_id, crowd_id, *args)
+        put("services/#{service_id}/crowd_table", {crowd_table: options.merge(args[0])})[:crowd_table]
+      end
+
+      def delete_crowd_table(service_id, crowd_id)
+        boolean_from_response :delete, "services/#{service_id}/crowd_table", options
+      end
+
+      def copy_crowd_table(service_id, services_ids)
+        boolean_from_response :post, "services/#{service_id}/crowd_table/copy/#{services_ids}", options
+      end
+    end
+  end
+end

data/lib/turba_kit/client/links.rb

@@ -0,0 +1,26 @@
+module TurbaKit
+  class Client
+    module Links
+      def service_link(service_id, link_id)
+        get("services/#{service_id}/links/#{link_id}")[:link]
+      end
+
+      def service_links(service_id)
+        get("services/#{service_id}/links")[:links]
+      end
+
+      def create_link(service_id, params, options = {})
+        # params = {text: text, url: url}
+        post("services/#{service_id}/links", {link: options.merge(params)})[:link]
+      end
+
+      def update_link(service_id, link_id, *args)
+        put("services/#{service_id}/links/#{link_id}", {link: options.merge(args[0])})[:link]
+      end
+
+      def delete_link(service_id, link_id)
+        boolean_from_response :delete, "services/#{service_id}/links/#{link_id}", options
+      end
+    end
+  end
+end

data/lib/turba_kit/client/migrations.rb

@@ -0,0 +1,15 @@
+module TurbaKit
+  class Client
+    module Migrations
+      def create_service_child(service_id)
+        params = {origin_id: service_id, migration: 'add_new_child'}
+        post("migrations", options.merge(params))
+      end
+
+      def create_migration(params)
+        p params
+        post("migrations", params)
+      end
+    end
+  end
+end

data/lib/turba_kit/client/notifications.rb

@@ -0,0 +1,26 @@
+module TurbaKit
+  class Client
+    module Notifications
+      def service_notification(service_id, notification_id)
+        get("services/#{service_id}/notifications/#{notification_id}")[:notification]
+      end
+
+      def service_notifications(service_id)
+        get("services/#{service_id}/notifications")[:notifications]
+      end
+
+      def create_notification(service_id, params, options = {})
+        # params = {text: text}
+        post("services/#{service_id}/notifications", {notification: options.merge(params)})[:notification]
+      end
+
+      def update_notification(service_id, notification_id, *args)
+        put("services/#{service_id}/notifications/#{notification_id}", {notification: options.merge(args[0])})[:notification]
+      end
+
+      def delete_notification(service_id, notification_id)
+        boolean_from_response :delete, "services/#{service_id}/notifications/#{notification_id}", options
+      end
+    end
+  end
+end

data/lib/turba_kit/client/organismes.rb

@@ -0,0 +1,41 @@
+module TurbaKit
+  class Client
+    module Organismes
+      def organisme(id_or_uri_id, *args)
+        get("organismes/#{id_or_uri_id}?#{query_string(args)}")[:organisme]
+      end
+
+      def organismes(*args)
+        get("organismes?#{query_string(args)}")[:organismes]
+      end
+
+      def create_organisme(params)
+        params = {organisme: params}
+        post("organismes", options.merge(params))[:organisme]
+      end
+
+      def delete_organisme(id_or_uri_id)
+        boolean_from_response :delete, "organismes/#{id_or_uri_id}", options
+      end
+
+      def search_organisme(query, *args)
+        get("organismes?q=#{query}&#{query_string(args)}")[:organismes]
+      end
+
+      # Update an organisme
+      #
+      # @param id_or_uri_id [String] ID of the organisme
+      # @param params [Hash] A customizable set of params.
+      # @option organisme_params [String] :title Category title.
+      # @option organisme_params [String] :url Category URL.
+      # @option organisme_params [String] :country_code Category country code.
+      # @return [Sawyer::Resource] The updated organisme
+      # @see https://github.com/turba-webservices/api-documentation/blob/master/v2/sections/organismes.md#update-organisme
+      # @example Change the title of Category xxxxxx
+      #   TurbaKit.update_issue("xxxxxx", {title: "A new title"})
+      def update_organisme(id_or_uri_id, organisme_params = {})
+        put("organismes/#{id_or_uri_id}", options.merge({organisme: organisme_params}))[:organisme]
+      end
+    end
+  end
+end

data/lib/turba_kit/client/phonenumbers.rb

@@ -0,0 +1,26 @@
+module TurbaKit
+  class Client
+    module Phonenumbers
+      def service_phonenumber(service_id, phonenumber_id)
+        get("services/#{service_id}/phonenumbers/#{phonenumber_id}")[:phonenumber]
+      end
+
+      def service_phonenumbers(service_id)
+        get("services/#{service_id}/phonenumbers")[:phonenumbers]
+      end
+
+      def create_phonenumber(service_id, params, options = {})
+        # params = {number: number, text: text}
+        post("services/#{service_id}/phonenumbers", {phonenumber: options.merge(params)})[:phonenumber]
+      end
+
+      def update_phonenumber(service_id, phonenumber_id, *args)
+        put("services/#{service_id}/phonenumbers/#{phonenumber_id}", {phonenumber: options.merge(args[0])})[:phonenumber]
+      end
+
+      def delete_phonenumber(service_id, phonenumber_id)
+        boolean_from_response :delete, "services/#{service_id}/phonenumbers/#{phonenumber_id}", options
+      end
+    end
+  end
+end

data/lib/turba_kit/client/places.rb

@@ -0,0 +1,26 @@
+module TurbaKit
+  class Client
+    module Places
+      def service_place(service_id, place_id)
+        get("services/#{service_id}/places/#{place_id}")[:place]
+      end
+
+      def service_places(service_id)
+        get("services/#{service_id}/places")[:places]
+      end
+
+      def create_place(service_id, params, options = {})
+        # params = {text: text, country: country, city: city}
+        post("services/#{service_id}/places", {place: options.merge(params)})[:place]
+      end
+
+      def update_place(service_id, place_id, *args)
+        put("services/#{service_id}/places/#{place_id}", {place: options.merge(args[0])})[:place]
+      end
+
+      def delete_place(service_id, place_id)
+        boolean_from_response :delete, "services/#{service_id}/places/#{place_id}", options
+      end
+    end
+  end
+end

data/lib/turba_kit/client/search.rb

@@ -0,0 +1,9 @@
+module TurbaKit
+  class Client
+    module Search
+      def search(query, *args)
+        get("search?q=#{query}&#{query_string(args)}")
+      end
+    end
+  end
+end

data/lib/turba_kit/client/services.rb

@@ -0,0 +1,41 @@
+module TurbaKit
+  class Client
+    module Services
+      def service(id_or_uri_id, *args)
+        get("services/#{id_or_uri_id}?#{query_string(args)}")[:service]
+      end
+
+      def services(*args)
+        get("services?#{query_string(args)}")[:services]
+      end
+
+      def create_service(params)
+        params = {service: params}
+        post("services", options.merge(params))[:service]
+      end
+
+      def delete_service(id_or_uri_id)
+        boolean_from_response :delete, "services/#{id_or_uri_id}", options
+      end
+
+      def search_service(query, *args)
+        get("services?q=#{query}&#{query_string(args)}")[:services]
+      end
+
+      # Update a service
+      #
+      # @param id_or_uri_id [String] ID of the service
+      # @param params [Hash] A customizable set of params.
+      # @option service_params [String] :title Category title.
+      # @option service_params [String] :url Category URL.
+      # @option service_params [String] :country_code Category country code.
+      # @return [Sawyer::Resource] The updated service
+      # @see https://github.com/turba-webservices/api-documentation/blob/master/v2/sections/services.md#update-service
+      # @example Change the title of Category xxxxxx
+      #   TurbaKit.update_issue("xxxxxx", {title: "A new title"})
+      def update_service(id_or_uri_id, service_params = {})
+        put("services/#{id_or_uri_id}", options.merge({service: service_params}))[:service]
+      end
+    end
+  end
+end

data/lib/turba_kit/client/tips.rb

@@ -0,0 +1,26 @@
+module TurbaKit
+  class Client
+    module Tips
+      def service_tip(service_id, tip_id)
+        get("services/#{service_id}/tips/#{tip_id}")[:tip]
+      end
+
+      def service_tips(service_id)
+        get("services/#{service_id}/tips")[:tips]
+      end
+
+      def create_tip(service_id, params, options = {})
+        # params = {title: title, text: text}
+        post("services/#{service_id}/tips", {tip: options.merge(params)})[:tip]
+      end
+
+      def update_tip(service_id, tip_id, *args)
+        put("services/#{service_id}/tips/#{tip_id}", {tip: options.merge(args[0])})[:tip]
+      end
+
+      def delete_tip(service_id, tip_id)
+        boolean_from_response :delete, "services/#{service_id}/tips/#{tip_id}", options
+      end
+    end
+  end
+end

data/lib/turba_kit/client.rb

@@ -0,0 +1,168 @@
+require 'sawyer'
+require 'turba_kit/arguments'
+require 'turba_kit/authentication'
+require 'turba_kit/configurable'
+require 'turba_kit/client/categories'
+require 'turba_kit/client/organismes'
+require 'turba_kit/client/services'
+require 'turba_kit/client/countries'
+require 'turba_kit/client/phonenumbers'
+require 'turba_kit/client/contents'
+require 'turba_kit/client/links'
+require 'turba_kit/client/tips'
+require 'turba_kit/client/places'
+require 'turba_kit/client/notifications'
+require 'turba_kit/client/crowd_table'
+require 'turba_kit/client/comments'
+require 'turba_kit/client/checkins'
+require 'turba_kit/client/search'
+require 'turba_kit/client/migrations'
+
+module TurbaKit
+
+  # Client for the Turba API
+  #
+  # @see http://github.com/turba-webservices/turba_kit
+  class Client
+
+    include TurbaKit::Authentication
+    include TurbaKit::Configurable
+    include TurbaKit::Client::Categories
+    include TurbaKit::Client::Organismes
+    include TurbaKit::Client::Services
+    include TurbaKit::Client::Countries
+    include TurbaKit::Client::Phonenumbers
+    include TurbaKit::Client::Contents
+    include TurbaKit::Client::Links
+    include TurbaKit::Client::Tips
+    include TurbaKit::Client::Places
+    include TurbaKit::Client::Notifications
+    include TurbaKit::Client::CrowdTable
+    include TurbaKit::Client::Comments
+    include TurbaKit::Client::Checkins
+    include TurbaKit::Client::Search
+    include TurbaKit::Client::Migrations
+
+    # Header keys that can be passed in options hash to {#get},{#head}
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+    def initialize(options = {})
+      TurbaKit::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || TurbaKit.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 api key
+    #
+    # @return [String]
+    def inspect
+      inspected = super
+
+      # Only show last 4 of api key, secret
+      if @api_key
+        inspected = inspected.gsub! @api_key, "#{'*'*36}#{@api_key[36..-1]}"
+      end
+
+      inspected
+    end
+
+    def get(url, options = {})
+      request :get, url, parse_query_and_convenience_headers(options)
+    end
+
+    def post(url, options = {})
+      request :post, url, options
+    end
+
+    def put(url, options = {})
+      request :put, url, options
+    end
+
+    def delete(url, options = {})
+      request :delete, url, options
+    end
+
+    def last_response
+      @last_response if defined? @last_response
+    end
+
+    def agent
+      @agent ||= Sawyer::Agent.new("#{api_endpoint}#{api_version}/", sawyer_options) do |http|
+        http.headers[:accept] = default_media_type
+        http.headers[:user_agent] = user_agent
+        http.headers['X-API-KEY'] = api_key
+      end
+    end
+
+    # Fetch the root resource for the API
+    #
+    # @return [Sawyer::Resource]
+    def root
+      get "/"
+    end
+
+  private
+
+    def query_string(*args)
+      return if args.flatten.blank?
+      query_string = ''
+      arguments = TurbaKit::Arguments.new(args).flatten[0]
+      query_string = arguments.map {|k, v| "#{k}=#{v}"}.join('&')
+      query_string
+    end
+
+    def boolean_from_response(method, path, options = {})
+      request(method, path, options)
+      @last_response.status == 204
+    rescue TurbaKit::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[:serializer] = Sawyer::Serializer.message_pack
+      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
+
+    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, URI::Parser.new.escape(path.to_s), data, options)
+
+      response.data
+    end
+  end
+end