ruby-trello 2.0.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aef36c181b18bcb01b8a45c21aad954536f40188
-  data.tar.gz: 1271b238eae444a32c6c84ea9c3cf8c26fe50a98
+SHA256:
+  metadata.gz: 7e7396e189c2f3b43af4bf1eacbdd78ec358ef684d2526d7c3537c1af1ca4abd
+  data.tar.gz: c8e2c74d10eaedb521829b3598e4500119c8fbfdd8c8cd71758254580eee1079
 SHA512:
-  metadata.gz: 86b932d63a9e11a9d63ab20233e67aeb241cc5203bfd689d56f5323c8a31dfbb5dfd1d6b5873571d50fad68487033ead6b70282b7e52557ffd72b7bb81cd70fa
-  data.tar.gz: b03c3113250ff01a490bb39304e7d7ed4dc7a64f61a6c7feb923138a7621e0034b73bfeee58c796e017485a0d2b0d5f46c80ab907c68b19c0f2f19dc503d91bc
+  metadata.gz: 1d441be6f124b3dd47ff332da22ccbf71eb201ff90ddf82775fc3f208eb6621dd10acc2cff21c81d30231d9b50f4aa9cf867cf66d26e9c894e16f1a1596a11fa
+  data.tar.gz: 647e16d5104ba1cf8dc3a7811117f168d6e132503e4b0989e8316a8abd9b30f3401cc04814da202cb4fc74846c5b9dee88a80fc36358fa0cd9c5f65340aba97b

data/README.md

@@ -1,35 +1,37 @@
 # Ruby Trello API
 
-[![Stories in Ready](http://badge.waffle.io/jeremytregunna/ruby-trello.png)](http://waffle.io/jeremytregunna/ruby-trello)
-[![Build Status](https://secure.travis-ci.org/jeremytregunna/ruby-trello.png)](http://travis-ci.org/jeremytregunna/ruby-trello) [![Dependency Status](https://gemnasium.com/jeremytregunna/ruby-trello.png)](https://gemnasium.com/jeremytregunna/ruby-trello)
+[![Build Status](https://secure.travis-ci.org/jeremytregunna/ruby-trello.svg)](http://travis-ci.org/jeremytregunna/ruby-trello)
+[![security](https://hakiri.io/github/jeremytregunna/ruby-trello/master.svg)](https://hakiri.io/github/jeremytregunna/ruby-trello/master)
 [![Code Climate](https://codeclimate.com/github/jeremytregunna/ruby-trello/badges/gpa.svg)](https://codeclimate.com/github/jeremytregunna/ruby-trello)
 
-This library implements the [Trello](http://www.trello.com/) [API](http://trello.com/api).
+This library implements the [Trello](http://www.trello.com/) [API](https://developers.trello.com/).
 
 Trello is an awesome tool for organization. Not just aimed at developers, but everybody.
 Seriously, [check it out](http://www.trello.com/).
 
 [Full API documentation](http://www.rubydoc.info/gems/ruby-trello).
 
+Full Disclosure: This library is mostly complete, if you do find anything missing or not functioning as you expect it
+to, please just [create an issue](https://github.com/jeremytregunna/ruby-trello/issues/new).
+
+## Requirements
+
+Use the newest version for Ruby 2.5.0 or newer support.
+Use version 2.2.1 or earlier for Ruby 2.1 ~ 2.4 support.
+Use version 1.3.0 or earlier for Ruby 1.9.3 support.
+Use version 1.4.x or earlier for Ruby 2.0.0 support.
+
 ## Installation
 
 ```
 # gem install ruby-trello
 ```
 
-Full Disclosure: This library is mostly complete, if you do find anything missing or not functioning as you expect it
-to, please [let us know](https://trello.com/card/spot-a-bug-report-it/4f092b2ee23cb6fe6d1aaabd/17).
-
-Supports Ruby 2.1.0 or newer.
-
-Use version 1.3.0 or earlier for ruby 1.9.3 support.
-Use version 1.4.x or earlier for ruby 2.0.0 support.
-
 ## Configuration
 
-####Basic authorization:
+#### Basic authorization:
 
-1. Get your API public key from Trello via the irb console:
+1. Get your API public key from Trello via [trello.com/app-key/](https://trello.com/app-key/) or the irb console as follows:
 
 ```
 $ gem install ruby-trello
@@ -50,7 +52,7 @@ Trello.configure do |config|
 end
 ```
 
-####2-legged OAuth authorization
+#### 2-legged OAuth authorization
 
 ```ruby
 Trello.configure do |config|
@@ -61,7 +63,7 @@ Trello.configure do |config|
 end
 ```
 
-####3-legged OAuth authorization
+#### 3-legged OAuth authorization
 
 ```ruby
 Trello.configure do |config|
@@ -72,18 +74,67 @@ Trello.configure do |config|
 end
 ```
 
-All the calls this library make to Trello require authentication using these keys. Be sure to protect them.
+All the calls this library makes to Trello require authentication using these keys. Be sure to protect them.
+
+#### Usage
 
-So lets say you want to get information about the user *bobtester*. We can do something like this:
+So let's say you want to get information about the user *bobtester*. We can do something like this:
 
 ```ruby
 bob = Trello::Member.find("bobtester")
+
 # Print out his name
 puts bob.full_name # "Bob Tester"
+
 # Print his bio
 puts bob.bio # A wonderfully delightful test user
+
 # How about a list of his boards?
 bob.boards
+
+# And then to read the lists of the first board do : 
+bob.boards.first.lists
+```
+
+##### Accessing specific items
+
+There is no find by name method in the trello API, to access a specific item, you have to know it's ID.
+The best way is to pretty print the elements and then find the id of the element you are looking for.
+
+```ruby
+# With bob
+pp bob.boards # Will pretty print all boards, allowing us to find our board id
+
+# We can now access it's lists
+pp Trello::Board.find( board_id ).lists # will pretty print all lists. Let's get the list id
+
+# We can now access the cards of the list
+pp Trello::List.find( list_id ).cards
+
+# We can now access the checklists of the card
+pp Trello::Card.find( card_id ).checklists
+
+# and so on ...
+```
+
+##### Changing a checkbox state
+```ruby
+# First get your checklist id 
+checklist = Trello::Checklist.find( checklist_id )
+
+# At this point, there is no more ids. To get your checklist item, 
+# you have to know it's position (same as in the trello interface).
+# Let's take the first
+checklist_item = checklist.items.first
+
+# Then we can read the status
+checklist_item.state # return 'complete' or 'incomplete'
+
+# We can update it (note we call update_item_state from checklist, not from checklist_item)
+checklist.update_item_state( checklist_item.id, 'complete' ) # or 'incomplete'
+
+# You can also use true or false instead of 'complete' or 'incomplete'
+checklist.update_item_state( checklist_item.id, true ) # or false
 ```
 
 #### Multiple Users
@@ -131,3 +182,41 @@ Several ways you can contribute. Documentation, code, tests, feature requests, b
 If you submit a pull request that's accepted, you'll be given commit access to this repository.
 
 Please see the `CONTRIBUTING.md` file for more information.
+
+## Local Development
+
+Init all Gemfile.lock.* files
+
+```bash
+make init
+```
+
+Bundle install for all Ruby versions
+
+```bash
+make bundle:all
+```
+
+Run tests for all Ruby versions
+
+```bash
+make test:all
+```
+
+Run tests for each Ruby versions individual
+
+```bash
+make test:ruby_2_5
+make test:ruby_2_6
+make test:ruby_2_7
+make test:jruby_9_2
+```
+
+Do development for each Ruby versions individual
+
+```bash
+make dev:ruby_2_5
+make dev:ruby_2_6
+make dev:ruby_2_7
+make dev:jruby_9_2
+```

data/lib/trello.rb

@@ -37,47 +37,60 @@ require 'addressable/uri'
 #
 # Feel free to {peruse and participate in our Trello board}[https://trello.com/board/ruby-trello/4f092b2ee23cb6fe6d1aaabd]. It's completely open to the public.
 module Trello
-  autoload :Action,            'trello/action'
-  autoload :Comment,           'trello/comment'
-  autoload :Association,       'trello/association'
-  autoload :AssociationProxy,  'trello/association_proxy'
-  autoload :Attachment,        'trello/attachment'
-  autoload :CoverImage,        'trello/cover_image'
-  autoload :BasicData,         'trello/basic_data'
-  autoload :Board,             'trello/board'
-  autoload :Card,              'trello/card'
-  autoload :Checklist,         'trello/checklist'
-  autoload :Client,            'trello/client'
-  autoload :Configuration,     'trello/configuration'
-  autoload :HasActions,        'trello/has_actions'
-  autoload :Item,              'trello/item'
-  autoload :CheckItemState,    'trello/item_state'
-  autoload :Label,             'trello/label'
-  autoload :LabelName,         'trello/label_name'
-  autoload :List,              'trello/list'
-  autoload :Member,            'trello/member'
-  autoload :MultiAssociation,  'trello/multi_association'
-  autoload :Notification,      'trello/notification'
-  autoload :Organization,      'trello/organization'
-  autoload :PluginDatum,       'trello/plugin_datum'
-  autoload :Request,           'trello/net'
-  autoload :TInternet,         'trello/net'
-  autoload :Token,             'trello/token'
-  autoload :Webhook,           'trello/webhook'
-  autoload :JsonUtils,         'trello/json_utils'
+  autoload :Error,                'trello/error'
+  autoload :Action,               'trello/action'
+  autoload :Comment,              'trello/comment'
+  autoload :Association,          'trello/association'
+  autoload :AssociationProxy,     'trello/association_proxy'
+  autoload :Attachment,           'trello/attachment'
+  autoload :CoverImage,           'trello/cover_image'
+  autoload :BasicData,            'trello/basic_data'
+  autoload :Board,                'trello/board'
+  autoload :Card,                 'trello/card'
+  autoload :Checklist,            'trello/checklist'
+  autoload :Client,               'trello/client'
+  autoload :Configuration,        'trello/configuration'
+  autoload :CustomField,          'trello/custom_field'
+  autoload :CustomFieldItem,      'trello/custom_field_item'
+  autoload :CustomFieldOption,    'trello/custom_field_option'
+  autoload :HasActions,           'trello/has_actions'
+  autoload :Item,                 'trello/item'
+  autoload :CheckItemState,       'trello/item_state'
+  autoload :Label,                'trello/label'
+  autoload :LabelName,            'trello/label_name'
+  autoload :List,                 'trello/list'
+  autoload :Member,               'trello/member'
+  autoload :MultiAssociation,     'trello/multi_association'
+  autoload :Notification,         'trello/notification'
+  autoload :Organization,         'trello/organization'
+  autoload :PluginDatum,          'trello/plugin_datum'
+  autoload :Request,              'trello/net'
+  autoload :TInternet,            'trello/net'
+  autoload :Token,                'trello/token'
+  autoload :Webhook,              'trello/webhook'
+  autoload :JsonUtils,            'trello/json_utils'
+  autoload :AssociationInferTool, 'trello/association_infer_tool'
+  autoload :RegisterAttributes,   'trello/register_attributes'
 
   module Authorization
-    autoload :AuthPolicy,      'trello/authorization'
-    autoload :BasicAuthPolicy, 'trello/authorization'
-    autoload :OAuthPolicy,     'trello/authorization'
+    autoload :AuthPolicy,         'trello/authorization'
+    autoload :BasicAuthPolicy,    'trello/authorization'
+    autoload :OAuthPolicy,        'trello/authorization'
+  end
+
+  module AssociationFetcher
+    autoload :HasMany,            'trello/association_fetcher/has_many'
+    autoload :HasOne,            'trello/association_fetcher/has_one'
+  end
+
+  module AssociationBuilder
+    autoload :HasMany,            'trello/association_builder/has_many'
+    autoload :HasOne,            'trello/association_builder/has_one'
   end
 
   # Version of the Trello API that we use by default.
   API_VERSION = 1
 
-  # Raise this when we hit a Trello error.
-  Error = Class.new(StandardError)
-
   # This specific error is thrown when your access token is invalid. You should get a new one.
   InvalidAccessToken = Class.new(Error)
 

data/lib/trello/action.rb

@@ -38,12 +38,12 @@ module Trello
     # Supply a hash of string keyed data retrieved from the Trello API representing
     # an Action.
     def update_fields(fields)
-      attributes[:id]                 = fields['id']
-      attributes[:type]               = fields['type']
-      attributes[:data]               = fields['data']
-      attributes[:date]               = Time.iso8601(fields['date'])
-      attributes[:member_creator_id]  = fields['idMemberCreator']
-      attributes[:member_participant] = fields['member']
+      attributes[:id]                 = fields['id'] || attributes[:id]
+      attributes[:type]               = fields['type'] || attributes[:type]
+      attributes[:data]               = fields['data'] || attributes[:data]
+      attributes[:date]               = Time.iso8601(fields['date']) rescue nil if fields.has_key?('date')
+      attributes[:member_creator_id]  = fields['idMemberCreator'] || attributes[:member_creator_id]
+      attributes[:member_participant] = fields['member'] || attributes[:member_participant]
       self
     end
 
@@ -62,7 +62,9 @@ module Trello
       List.from_response client.get("/actions/#{id}/list")
     end
 
-    # Returns the member who created the action.
-    one :member_creator, via: Member, path: :members, using: :member_creator_id
+    # Returns the list the action occurred on.
+    def member_creator
+      Member.from_response client.get("/actions/#{id}/memberCreator")
+    end
   end
 end

data/lib/trello/association_builder/has_many.rb

@@ -0,0 +1,17 @@
+module Trello
+  module AssociationBuilder
+    class HasMany
+      class << self
+        def build(model_klass, name, options)
+          model_klass.class_eval do
+            define_method(name) do |*args|
+              has_many_fetcher = AssociationFetcher::HasMany.new(self, name, options)
+              filter_params = args[0] || {}
+              has_many_fetcher.fetch(filter_params)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trello/association_builder/has_one.rb

@@ -0,0 +1,16 @@
+module Trello
+  module AssociationBuilder
+    class HasOne
+      class << self
+        def build(model_klass, name, options)
+          model_klass.class_eval do
+            define_method(name) do |*args|
+              has_one_fetcher = AssociationFetcher::HasOne.new(self, name, options)
+              has_one_fetcher.fetch
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trello/association_fetcher/has_many.rb

@@ -0,0 +1,26 @@
+module Trello
+  module AssociationFetcher
+    class HasMany
+      autoload :Params, 'trello/association_fetcher/has_many/params'
+      autoload :Fetch, 'trello/association_fetcher/has_many/fetch'
+
+      attr_reader :model, :name, :options
+
+      def initialize(model, name, options)
+        @model = model
+        @name = name
+        @options = options
+      end
+
+      def fetch(filter_params)
+        params = Params.new(
+          association_owner: model,
+          association_name: name,
+          association_options: options,
+          filter: filter_params 
+        )
+        Fetch.execute(params)
+      end
+    end
+  end
+end

data/lib/trello/association_fetcher/has_many/fetch.rb

@@ -0,0 +1,47 @@
+module Trello
+  module AssociationFetcher
+    class HasMany
+      class Fetch
+        class << self
+          def execute(params)
+            new(params).execute
+          end
+        end
+
+        attr_reader :params
+
+        def initialize(params)
+          @params = params
+        end
+
+        def execute
+          resources = client.find_many(association_class, path, filter_params)
+
+          MultiAssociation.new(association_owner, resources).proxy
+        end
+
+        private
+
+        def client
+          association_owner.client
+        end
+
+        def association_class
+          params.association_class
+        end
+
+        def path
+          params.fetch_path
+        end
+
+        def filter_params
+          params.filter_params
+        end
+
+        def association_owner
+          params.association_owner
+        end
+      end
+    end
+  end
+end

data/lib/trello/association_fetcher/has_many/params.rb

@@ -0,0 +1,56 @@
+module Trello
+  module AssociationFetcher
+    class HasMany
+      class Params
+        attr_reader :association_owner
+
+        def initialize(association_owner:, association_name:, association_options:, filter:)
+          @association_owner = association_owner
+          @association_name = association_name
+          @association_options = association_options || {}
+          @filter = filter || {}
+        end
+
+        def association_class
+          association_options[:via] || infer_class_on(association_name)
+        end
+
+        def fetch_path
+          "/#{parent_restful_resource}/#{parent_restful_resource_id}/#{target_restful_resource}"
+        end
+
+        def filter_params
+          default_filter.merge(filter)
+        end
+
+        private
+
+        attr_reader :association_name, :association_options, :filter
+
+        def default_filter
+          association_options.reject { |k, _| %w[via in path].include?(k.to_s) }
+        end
+
+        def parent_restful_resource
+          association_options[:in] || infer_restful_resource_on(association_owner.class)
+        end
+
+        def parent_restful_resource_id
+          association_owner.id
+        end
+
+        def target_restful_resource
+          association_options[:path] || association_name
+        end
+
+        def infer_restful_resource_on(klass)
+          AssociationInferTool.infer_restful_resource_on_class(klass)
+        end
+
+        def infer_class_on(name)
+          AssociationInferTool.infer_class_on_name(name)
+        end
+      end
+    end
+  end
+end