trello_client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a85198454a25ff3a0623f1643445d8313670a939
-  data.tar.gz: 91685449c5bfbe430a2b4f9facd1538dc5ffeee7
+  metadata.gz: d3af84755627b202d28e5693c6875d2eb186bb89
+  data.tar.gz: 2e24446fe0cbfb58f0e9cad89c8e37e0ecdb1e5d
 SHA512:
-  metadata.gz: a3339653ee5da575a68b10f00ff8349ef9e26e7ea1ee7e935bc705a26bd307461d22b0260184ff984c568baf31d588c1dc5791684e3fbb56e2f216893bfa0621
-  data.tar.gz: 15777c22465f981cb921d3393489eb396d5cdbf66df9b4b6d02a1b15d42849f7bd9bd56f7ec6ffe5311c79443e30341041b1fbdb7b0260063a349742fac7f61b
+  metadata.gz: c77e7283e195d22cfd6e43ca6037b19cc98f286e9d26989632a1cb6fcf5c9997a8b564108712c35feee4c1fe0180b1045dd9d59d9013c63c30977f76434abd30
+  data.tar.gz: 9460643291431d6630f2bb923c8af01be7822a50d77ee69be580766a5ae2f7520d6b588db186ab3704fc8fa2e36b613f34211deba481731a4180944db6b2e013

data/README.md

@@ -1,8 +1,6 @@
 # TrelloClient
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/trello_client`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Easy to use, non official Trello Client based on [Trello API Docs](https://trello.readme.io/docs/api-introduction).
 
 ## Installation
 
@@ -22,7 +20,73 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Get key and token
+
+If this is your first time using Trello API, get key and token from [here](https://trello.com/app-key).
+
+### Client
+
+Create board/list/card clients based on api key and token.
+
+```ruby
+client = Trello::Client.new(key: <your-key>, token: <your-token>)
+board_client = Trello::Board.new(client)
+list_client  = Trello::List.new(client)
+card_client  = Trello::Card.new(client)
+```
+
+### Board
+
+Get all boards
+
+```ruby
+board_client.fetch_all
+```
+
+Get one board
+
+```ruby
+board_client.fetch(id: <board-id>)
+```
+
+### List
+
+Get all lists of a board
+
+```ruby
+list_client.fetch_all(board_id: <board-id>)
+```
+
+Get one list
+
+```ruby
+list_client.fetch(id: <list-id>)
+```
+
+### Card
+
+Get all cards of a list
+
+```ruby
+card_client.fetch_all(list_id: <list-id>)
+```
+
+Get one card
+
+```ruby
+card_client.fetch(id: <card-id>)
+```
+
+Create a card
+
+```ruby
+# options of body(as a hash):
+#   - name: name of card
+#   - desc: description
+#   - ...
+body = { name: "test", desc: "description", ... }
+card_client.add(list_id: <list-id>, body)
+```
 
 ## Development
 

data/lib/trello/api_object.rb

@@ -17,6 +17,11 @@ module Trello
       raise NotImplementedError
     end
 
+    def delete(id:)
+      raise unless id
+      @client.delete(resource_url(id))
+    end
+
     private
 
     def resources_url(**args)

data/lib/trello/board.rb

@@ -10,6 +10,14 @@ module Trello
       super
     end
 
+    def add(**args)
+      @client.post("/1/boards", args)
+    end
+
+    def delete(id:)
+      super
+    end
+
     private
 
     def resources_url(**args)

data/lib/trello/card.rb

@@ -13,6 +13,10 @@ module Trello
       @client.post("/1/cards", args.merge(idList: list_id))
     end
 
+    def delete(id:)
+      super
+    end
+
     private
 
     def resources_url(**args)

data/lib/trello/client.rb

@@ -19,6 +19,10 @@ module Trello
       @http_client.perform(:post, with_key_and_token(path), body.to_json)
     end
 
+    def delete(path)
+      @http_client.perform(:delete, with_key_and_token(path))
+    end
+
     private
 
     def with_key_and_token(path)

data/lib/trello/list.rb

@@ -9,6 +9,10 @@ module Trello
       super
     end
 
+    def add(board_id:, **args)
+      @client.post("/1/lists", args.merge(idBoard: board_id))
+    end
+
     private
 
     def resources_url(**args)

data/lib/trello_client.rb

@@ -8,5 +8,5 @@ require "trello/list"
 require "trello/card"
 
 module TrelloClient
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trello_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chen Huang