tacokit 0.1.0 → 0.2.0

data/lib/tacokit/client.rb

@@ -1,27 +1,30 @@
-require 'forwardable'
-
-require 'faraday'
-require 'faraday_middleware'
-
-require 'tacokit/authorization'
-require 'tacokit/configuration'
-require 'tacokit/middleware'
-require 'tacokit/response'
-require 'tacokit/transform'
-
-require 'tacokit/client/actions'
-require 'tacokit/client/boards'
-require 'tacokit/client/cards'
-require 'tacokit/client/checklists'
-require 'tacokit/client/labels'
-require 'tacokit/client/lists'
-require 'tacokit/client/members'
-require 'tacokit/client/notifications'
-require 'tacokit/client/organizations'
-require 'tacokit/client/searches'
-require 'tacokit/client/tokens'
-require 'tacokit/client/types'
-require 'tacokit/client/webhooks'
+require "forwardable"
+
+require "addressable/uri"
+
+require "faraday"
+require "faraday_middleware"
+
+require "tacokit/authorization"
+require "tacokit/collection"
+require "tacokit/configuration"
+require "tacokit/middleware"
+require "tacokit/response"
+require "tacokit/transform"
+
+require "tacokit/client/actions"
+require "tacokit/client/boards"
+require "tacokit/client/cards"
+require "tacokit/client/checklists"
+require "tacokit/client/labels"
+require "tacokit/client/lists"
+require "tacokit/client/members"
+require "tacokit/client/notifications"
+require "tacokit/client/organizations"
+require "tacokit/client/searches"
+require "tacokit/client/tokens"
+require "tacokit/client/types"
+require "tacokit/client/webhooks"
 
 module Tacokit
   class Client
@@ -47,10 +50,12 @@ module Tacokit
     def_delegators :configuration, *Configuration.keys
     def_delegators :configuration, :user_authenticated?, :user_credentials
     def_delegators :configuration, :app_authenticated?, :app_credentials
-    def_delegators :transform, :serialize, :deserialize
+    def_delegators :transform, :serialize, :deserialize, :serialize_params
+
+    attr_accessor :last_response
 
     def initialize(options = {})
-      self.configuration.options = options
+      configuration.options = options
     end
 
     def reset!
@@ -81,61 +86,24 @@ module Tacokit
       request :delete, url, options
     end
 
+    def paginated_get(*args)
+      Collection.new(self, :get, *args)
+    end
+
     def request(method, url, data = nil, params = nil)
       if [:get, :body].include?(method)
         params ||= data
         data      = nil
       end
 
-      params = normalize_request_params(params || {})
       response = connection.send method, url do |req|
-        req.params.update params
+        req.params.update serialize_params(params)
         req.body = serialize(data) if data
       end
 
-      Response.new(self, response).data
-    end
-
-    def transform
-      @transform ||= Transform.new
-    end
-
-    # Prepare ruby-style params for trello request
-    def normalize_request_params(params)
-      {}.tap do |norm|
-        params.each do |key,value|
-          norm[key] = normalize_param_value(value)
-        end
-      end
-    end
+      @last_response = last_response = Response.new(self, response)
 
-    def normalize_param_value(value)
-      case value
-      when Array
-        value.map { |v| camp(v) }.join(',')
-      when /\,/
-        normalize_param_value(value.split(','))
-      else
-        camp(value)
-      end
-    end
-
-    def path_join(*paths)
-      paths.join('/')
-    end
-
-    def to_path(*paths)
-      warn "to_path is deprecated"
-      path_join(*paths)
-    end
-
-    def camel_path(path)
-      camelize(path.to_s, :lower)
-    end
-    alias camp camel_path
-
-    def camel_join(*paths)
-      path_join paths.map { |p| camel_path(p) }
+      last_response.data
     end
 
     def to_s
@@ -143,13 +111,19 @@ module Tacokit
     end
     alias_method :inspect, :to_s
 
+    private
+
+    def transform
+      @transform ||= Transform.new
+    end
+
     def connection
-      @connection = Faraday.new(url: api_endpoint) do |http|
-        http.headers[:user_agent] = 'TacoKit 0.0.1'
+      @connection ||= Faraday.new(url: api_endpoint) do |http|
+        http.headers[:user_agent] = "TacoKit 0.0.1"
 
         if user_authenticated?
           http.request :oauth, user_credentials
-        else app_authenticated?
+        elsif app_authenticated?
           http.params.update app_credentials
         end
 
@@ -159,11 +133,10 @@ module Tacokit
 
         http.response :json, content_type: /\bjson$/
         http.response :boom
-        http.response :logger if ENV['DEBUG']
+        http.response :logger if ENV["DEBUG"]
 
         http.adapter Faraday.default_adapter
       end
     end
-
   end
 end

data/lib/tacokit/collection.rb

@@ -0,0 +1,49 @@
+require "forwardable"
+
+module Tacokit
+  class Collection
+    include Enumerable
+    extend Forwardable
+
+    MAX = 1000
+
+    def_delegators :@collection, :[], :empty?, :size
+
+    def initialize(client, method, path, options)
+      @client, @method, @path, @options = client, method, path, options
+
+      @page  = options.fetch(:page, 0)
+      @limit = options.fetch(:limit, 50)
+
+      @collection = []
+
+      fetch_next_page
+    end
+
+    def each(start = 0)
+      return to_enum(:each, start) unless block_given?
+      Array(@collection[start..-1]).each do |element|
+        yield(element)
+      end
+      unless last?
+        start = [@collection.size, start].max
+        fetch_next_page
+        each(start, &Proc.new)
+      end
+      self
+    end
+
+    private
+
+    def last?
+      @last_response_empty || (@page * @limit) >= MAX
+    end
+
+    def fetch_next_page
+      response = @client.send(@method, @path, @options.merge(page: @page))
+      @last_response_empty = response.empty?
+      @page += 1
+      @collection += response
+    end
+  end
+end

data/lib/tacokit/configuration.rb

@@ -1,6 +1,5 @@
 module Tacokit
   class Configuration
-
     API_URL = "https://api.trello.com".freeze
     WEB_URL = "https://trello.com".freeze
 
@@ -41,7 +40,7 @@ module Tacokit
     end
 
     def app_credentials
-      { key: app_key, token: app_token }.delete_if { |k,v| v.nil? }
+      { key: app_key, token: app_token }.delete_if { |k, v| v.nil? }
     end
 
     private
@@ -50,11 +49,10 @@ module Tacokit
       {
         api_endpoint: File.join(API_URL, API_VERSION),
         web_endpoint: File.join(WEB_URL, API_VERSION),
-        app_key: ENV['TRELLO_APP_KEY'],
-        app_secret: ENV['TRELLO_APP_SECRET'],
-        app_token: ENV['TRELLO_APP_TOKEN']
+        app_key: ENV["TRELLO_APP_KEY"],
+        app_secret: ENV["TRELLO_APP_SECRET"],
+        app_token: ENV["TRELLO_APP_TOKEN"]
       }
     end
-
   end
 end

data/lib/tacokit/error.rb

@@ -25,7 +25,5 @@ module Tacokit
 
     # 407
     ConnectionFailed = Class.new(ClientError)
-
   end
-
 end

data/lib/tacokit/middleware/boom.rb

@@ -1,26 +1,25 @@
 module Tacokit
   module Middleware
     class Boom < Faraday::Response::Middleware
-      ClientErrorStatuses = 400...600
+      CLIENT_ERROR_STATUSES = 400...600
 
       def on_complete(env)
         case env[:status]
         when 401
-          raise Tacokit::Error::Unauthorized.new(error_message(env))
+          raise Tacokit::Error::Unauthorized, error_message(env)
         when 404
-          raise Tacokit::Error::ResourceNotFound.new(error_message(env))
+          raise Tacokit::Error::ResourceNotFound, error_message(env)
         when 407
           # mimic the behavior that we get with proxy requests with HTTPS
-          raise Tacokit::Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
-        when ClientErrorStatuses
-          raise Tacokit::Error::ClientError.new(error_message(env))
+          raise Tacokit::Error::ConnectionFailed, %(407 "Proxy Authentication Required ")
+        when CLIENT_ERROR_STATUSES
+          raise Tacokit::Error::ClientError, error_message(env)
         end
       end
 
       def error_message(env)
         "Server returned #{env[:status]}: #{env.body}. Headers #{env.response_headers.inspect}"
       end
-
     end
   end
 end

data/lib/tacokit/middleware.rb

@@ -1,15 +1,7 @@
-require 'tacokit/middleware/boom'
-# require 'tacokit/middleware/debug'
+require "tacokit/middleware/boom"
 
 module Tacokit
   module Middleware
-
-    # Faraday::Request.register_middleware \
-    #   :example => lambda { Tacokit::Middleware::Example }
-    #
-
-    Faraday::Response.register_middleware \
-      :boom => lambda { Tacokit::Middleware::Boom }
-
+    Faraday::Response.register_middleware boom: -> { Tacokit::Middleware::Boom }
   end
 end

data/lib/tacokit/resource.rb

@@ -1,36 +1,25 @@
-require 'forwardable'
+require "forwardable"
 
 module Tacokit
   class Resource
-    SPECIAL_METHODS = Set.new(%w(client fields))
-    attr_reader :_client
-    attr_reader :_fields
-    attr_reader :attrs
-    alias to_hash attrs
-    alias to_h attrs
     include Enumerable
     extend Forwardable
 
-    def_delegators :@_fields, :fetch, :keys, :key?, :has_key?, :include?, :any?
+    SPECIAL_METHODS = Set.new(%w[fields])
+    attr_reader :_fields
+    attr_reader :attrs
+    alias_method :to_hash, :attrs
+    alias_method :to_h, :attrs
+
+    def_delegators :@_fields, :fetch, :keys, :any?
 
-    def initialize(client, data = {})
-      @_client = client
+    def initialize(data = {})
       @attrs = {}
-      @_metaclass = (class << self; self; end)
       @_fields = Set.new
       data.each do |key, value|
-        @_fields << key
         @attrs[key.to_sym] = process_value(value)
       end
-      @_metaclass.send(:attr_accessor, *data.keys)
-    end
-
-    def process_value(value)
-      case value
-      when Hash then self.class.new(@_client, value)
-      when Array then value.map { |v| process_value(v) }
-      else value
-      end
+      new_attrs(*data.keys)
     end
 
     def each(&block)
@@ -49,42 +38,55 @@ module Tacokit
       nil
     end
 
-    def self.attr_accessor(*attrs)
-      attrs.each do |attribute|
-        class_eval do
-          define_method attribute do
-            @attrs[attribute.to_sym]
-          end
+    def key?(key)
+      @_fields.include?(key)
+    end
+    alias_method :has_key?, :key?
+    alias_method :include?, :key?
+
+    def inspect
+      (to_attrs.respond_to?(:pretty_inspect) ? to_attrs.pretty_inspect : to_attrs.inspect)
+    end
 
-          define_method "#{attribute}=" do |value|
-            @attrs[attribute.to_sym] = value
-          end
+    alias_method :to_s, :inspect
 
-          define_method "#{attribute}?" do
-            !!@attrs[attribute.to_sym]
-          end
+    def to_attrs
+      hash = attrs.clone
+      hash.keys.each do |k|
+        if hash[k].is_a?(Resource)
+          hash[k] = hash[k].to_attrs
+        elsif hash[k].is_a?(Array) && hash[k].all? { |el| el.is_a?(Resource) }
+          hash[k] = hash[k].collect(&:to_attrs)
         end
       end
+      hash
+    end
+
+    def update(attributes)
+      attributes.each do |key, value|
+        send("#{key}=", value)
+      end
     end
 
-    ATTR_SETTER    = '='.freeze
-    ATTR_PREDICATE = '?'.freeze
+    private
+
+    def process_value(value)
+      case value
+      when Hash then self.class.new(value)
+      when Array then value.map { |v| process_value(v) }
+      else cast_value_type(value)
+      end
+    end
+
+    ATTR_SETTER    = "=".freeze
+    ATTR_PREDICATE = "?".freeze
 
-    # Provides access to a resource's attributes.
     def method_missing(method, *args)
       attr_name, suffix = method.to_s.scan(/([a-z0-9\_]+)(\?|\=)?$/i).first
       if suffix == ATTR_SETTER
-        @_metaclass.send(:attr_accessor, attr_name)
-        @_fields << attr_name.to_sym
-        send(method, args.first)
+        setter_missing(attr_name, args.first)
       elsif attr_name && @_fields.include?(attr_name.to_sym)
-        value = @attrs[attr_name.to_sym]
-        case suffix
-        when nil
-          @_metaclass.send(:attr_accessor, attr_name)
-          value
-        when ATTR_PREDICATE then !!value
-        end
+        getter_missing(attr_name, suffix)
       elsif suffix.nil? && SPECIAL_METHODS.include?(attr_name)
         instance_variable_get "@_#{attr_name}"
       elsif attr_name && !@_fields.include?(attr_name.to_sym)
@@ -94,21 +96,46 @@ module Tacokit
       end
     end
 
-    def inspect
-      to_attrs.respond_to?(:pretty_inspect) ? to_attrs.pretty_inspect : to_attrs.inspect
+    def new_attrs(*names)
+      names.map { |n| new_attr(n) }
     end
 
-    def to_attrs
-      hash = self.attrs.clone
-      hash.keys.each do |k|
-        if hash[k].is_a?(Tacokit::Resource)
-          hash[k] = hash[k].to_attrs
-        elsif hash[k].is_a?(Array) && hash[k].all?{|el| el.is_a?(Tacokit::Resource)}
-          hash[k] = hash[k].collect{|el| el.to_attrs}
-        end
+    def new_attr(name)
+      name = name.to_sym
+      @_fields << name
+      unless respond_to?(name)
+        define_singleton_method(name) { @attrs[name] }
+        define_singleton_method("#{name}=") { |v| @attrs[name] = v }
+        define_singleton_method("#{name}?") { !!@attrs[name] }
       end
-      hash
+      name
+    end
+
+    def setter_missing(attr_name, value)
+      new_attr(attr_name)
+      send("#{attr_name}=", value)
     end
 
+    def getter_missing(attr_name, suffix)
+      value = @attrs[attr_name.to_sym]
+      case suffix
+      when nil
+        new_attr(attr_name)
+        value
+      when ATTR_PREDICATE then !!value
+      end
+    end
+
+    # rubocop:disable Metrics/LineLength
+    ISO8601 = %r{^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])?$}.freeze
+    # rubocop:enable Metrics/LineLength
+    def cast_value_type(value)
+      case value
+      when ISO8601 then DateTime.parse(value)
+      else value
+      end
+    rescue
+      value
+    end
   end
 end

data/lib/tacokit/response.rb

@@ -1,6 +1,5 @@
 module Tacokit
   class Response
-
     attr_reader :client, :status, :headers, :env, :data
 
     def initialize(client, res, options = {})
@@ -11,13 +10,14 @@ module Tacokit
       @data     = process_data(@client.deserialize(res.body))
     end
 
+    private
+
     def process_data(data)
       case data
-      when Hash then Resource.new(client, data)
+      when Hash then Resource.new(data)
       when Array then data.map { |value| process_data(value) }
       else data
       end
     end
-
   end
 end

data/lib/tacokit/transform.rb

@@ -2,6 +2,10 @@ module Tacokit
   class Transform
     include Tacokit::Utils
 
+    def serialize_params(params)
+      normalize_request_params(params)
+    end
+
     def serialize(body)
       serialize_body(body)
     end
@@ -12,6 +16,25 @@ module Tacokit
 
     private
 
+    def normalize_request_params(params)
+      {}.tap do |norm|
+        (params || {}).each do |key, value|
+          norm[key] = normalize_param_value(value)
+        end
+      end
+    end
+
+    def normalize_param_value(value)
+      case value
+      when Array
+        value.map { |v| camel_path(v) }.join(",")
+      when /\,/
+        normalize_param_value(value.split(","))
+      else
+        camel_path(value)
+      end
+    end
+
     def serialize_body(body)
       case body
       when Hash
@@ -31,26 +54,25 @@ module Tacokit
 
     def camelize_key(key)
       k = key.to_s
-      k = k.gsub(%r{([a-zA-Z]+?)_id(s\b|\b)?$}, "id_\\1\\2")
-      k = k.gsub(%r{(#{camelize_special_cases.keys.join('|')})}) { |m| camelize_special_cases.fetch(m) }
+      k = k.gsub(%r{([a-zA-Z_]+?)_id(s\b|\b)?$}, "id_\\1\\2")
+      k = k.gsub(%r{(#{camelize_special_cases.keys.join("|")})}) { |m| camelize_special_cases.fetch(m) }
       camelize(k, :lower)
     end
 
     # Converts
-    # 'prefs' => { 'voting' => 'members' }
+    # "prefs" => { "voting" => "members" }
     # to
-    # 'prefs/voting' => 'members
+    # "prefs/voting" => "members
     #
     def flatten_nested_keys(body)
       options = {}
       body.each do |key, value|
-        if value.is_a?(Hash)
-          value = flatten_nested_keys(value.dup)
-          value.each do |nested_key, nested_value|
-            options["#{key}/#{nested_key}"] = nested_value
-          end
-          body.delete(key)
+        next unless value.is_a?(Hash)
+        value = flatten_nested_keys(value.dup)
+        value.each do |nested_key, nested_value|
+          options["#{key}/#{nested_key}"] = nested_value
         end
+        body.delete(key)
       end
       body.merge(options)
     end
@@ -78,7 +100,7 @@ module Tacokit
 
     def underscore_key(key)
       k = key.to_s
-      k = k.gsub(%r{(#{pluralize_special_cases.join('|')})}, "\\1s")
+      k = k.gsub(%r{(#{pluralize_special_cases.join("|")})}, "\\1s")
       k = underscore(k)
       k.gsub(%r{^id_([a-zA-Z_]+?)(s\b|\b)$}, "\\1_id\\2")
     end
@@ -89,9 +111,9 @@ module Tacokit
 
     def camelize_special_cases
       {
-        'callback_url' => 'callbackURL'
+        "callback_url" => "callbackURL",
+        "checklist_source_id" => "idChecklistSource"
       }
     end
-
   end
 end