booru 0.0.1

data/lib/booru/api/pool.rb

@@ -0,0 +1,101 @@
+# -*- encoding : utf-8 -*-
+module Booru
+  module API
+    module Pool
+
+      # List pools: This action searches and retrieves a list of pools. If you
+      # don't specify any parameters you'll get a list of all pools.
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :query - The title (optional).
+      #           :page  - The page (optional).
+      def list_pools(options = {})
+        base_url = '/pool/index'
+        query = query_string(base_url, options)
+        parse(get(query))
+      end
+
+      # List Posts: This action retrieves a list of posts in a specified
+      # pool. If you don't specify any parameters you'll get a list of all
+      # pools.
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :id   - The pool id number (optional).
+      #           :page - The page (optional).
+      def list_pool_posts(options = {})
+        base_url = '/pool/show'
+        query = query_string(base_url, options)
+        parse(get(query))
+      end
+
+      # Update: This action modifies a pool's attributes
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :id                - The pool id number.
+      #           :pool[name]        - The name.
+      #           :pool[is_public]   - 1 or 0, whether or not the pool is
+      #                                public.
+      #           :pool[description] - A description of the pool.
+      def update_pool(options = {})
+        base_url = '/pool/update'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      # Create: This action creates a pool with the specified attributes
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :pool[name]        - The name.
+      #           :pool[is_public]   - 1 or 0, whether or not the pool is
+      #                                public.
+      #           :pool[description] - A description of the pool.
+      def create_pool(options = {})
+        base_url = '/pool/create'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      # Destroy: This action deletes a pool
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :id - The pool id number.
+      def destroy_pool(options = {})
+        base_url = '/pool/destroy'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      alias_method :delete_pool, :destroy_pool
+
+      # Add Post: This action adds a post to the specified pool
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :pool_id - The pool to add the post to.
+      #           :post_id - The post to add.
+      #
+      # Potential error reasons: "Post already exists", "access denied"
+      def add_pool_post(options = {})
+        base_url = '/pool/add_post'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      alias_method :add_post_to_pool, :add_pool_post
+
+      # Remove Post: This action remove a post from the specified pool
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :pool_id - The pool to remove the post from.
+      #           :post_id - The post to remove.
+      #
+      # Potential error reasons: "access denied"
+      def remove_pool_post(options = {})
+        base_url = '/pool/remove_post'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      alias_method :remove_post_from_pool, :remove_pool_post
+    end
+  end
+end

data/lib/booru/api/post.rb

@@ -0,0 +1,153 @@
+# -*- encoding : utf-8 -*-
+module Booru
+  module API
+    module Post
+
+      # List: This action retrieves a list of posts
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :limit - How many posts you want to retrieve. There is a
+      #                    hard limit of 100 posts per request
+      #                    (default: 100).
+      #           :page  - The page number (default: 1).
+      #           :tags  - The tags to search for. Any tag combination that
+      #                    works on the web site will work here. This
+      #                    includes all the meta-tags.
+      def list_posts(options = {})
+        base_url = '/post/index'
+        defaults = {:limit => 100, :page => 1}
+        options = defaults.merge(options)
+
+        query = query_string(base_url, options)
+        parse(get(query))
+      end
+
+      # Create: This action creates a post
+      #
+      # There are only two mandatory fields: you need to supply the tags,
+      # and you need to supply the file, either through a multipart form
+      # or through a source URL.
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :post[tags]             - A space delimited list of tags
+      #                                     (optional).
+      #           :post[file]             - The file data encoded as a
+      #                                     multipart form (optional).
+      #           :post[rating]           - The rating for the post
+      #                                     (optional).
+      #                                     Can be: safe, questionable, or
+      #                                     explicit.
+      #           :post[source]           - If this is a URL, Danbooru will
+      #                                     download the file (optional).
+      #           :post[is_rating_locked] - Set to true to prevent others
+      #                                     from changing the rating
+      #                                     (optional).
+      #           :post[is_note_locked]   - Set to true to prevent others
+      #                                     from adding notes (optional).
+      #           :post[parent_id]        - The ID of the parent post
+      #                                     (optional).
+      #           :md5                    - Supply an MD5 if you want
+      #                                     Danbooru to verify the file
+      #                                     after uploading it. If the MD5
+      #                                     doesn't match, the post is
+      #                                     destroyed (optional).
+      #
+      # If the call fails, the following response reasons are possible:
+      #   MD5 mismatch: This means you supplied an MD5 parameter and what
+      #                 Danbooru got doesn't match. Try uploading the file
+      #                 again.
+      #   duplicate:    This post already exists in Danbooru (based on the
+      #                 MD5 hash). An additional attribute called location
+      #                 will be set, pointing to the (relative) URL of the
+      #                 original post.
+      #   other:        Any other error will print its error message.
+      #
+      # If the post upload succeeded, you'll get an attribute called
+      # location in the response pointing to the relative URL of your
+      # newly uploaded post.
+      def create_post(options = {})
+        base_url = '/post/create'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      # Update: This action updates a post's attributes
+      #
+      # Only the id parameter is required. Leave the other parameters blank
+      # if you don't want to change them.
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :id                     - The id number of the post to
+      #                                     update.
+      #           :post[tags]             - A space delimited list of tags
+      #                                     (optional).
+      #           :post[file]             - The file data encoded as a
+      #                                     multipart form (optional).
+      #           :post[rating]           - The rating for the post
+      #                                     (optional).
+      #                                     Can be: safe, questionable, or
+      #                                     explicit.
+      #           :post[source]           - If this is a URL, Danbooru will
+      #                                     download the file (optional).
+      #           :post[is_rating_locked] - Set to true to prevent others
+      #                                     from changing the rating
+      #                                     (optional).
+      #           :post[is_note_locked]   - Set to true to prevent others
+      #                                     from adding notes (optional).
+      #           :post[parent_id]        - The ID of the parent post
+      #                                     (optional).
+      def update_post(options = {})
+        base_url = '/post/update'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      # Destroy: This action lets you delete a post.
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :id - The id number of the post to delete.
+      #
+      # You must be logged in to use this action. You must also be the
+      # user who uploaded the post (or you must be a moderator).
+      def destroy_post(options = {})
+        base_url = '/post/destroy'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      alias_method :delete_post, :destroy_post
+
+      # Revert Tags: This action reverts a post to a previous set of tags.
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :id         - The post id number to update.
+      #           :history_id - The id number of the tag history.
+      def revert_post_tags(options = {})
+        base_url = '/post/revert_tags'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      alias_method :revert_post, :revert_post_tags
+
+      # Vote: This action lets you vote for a post. You can only vote
+      # once per post per IP address.
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :id    - The post id number to update.
+      #           :score - Set to 1 to vote up and -1 to vote down. All
+      #                    other values will be ignored.
+      #
+      # If the call did not succeed, the following reasons are possible:
+      #   Already voted: You have already voted for this post.
+      #   Invalid score: You have supplied an invalid score.
+      def post_vote(options = {})
+        base_url = '/post/vote'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      alias_method :vote_on_post, :post_vote
+    end
+  end
+end

data/lib/booru/api/tag.rb

@@ -0,0 +1,57 @@
+# -*- encoding : utf-8 -*-
+module Booru
+  module API
+    module Tag
+
+      # List: This action retrieves a list of tags
+      # TODO optional/required args
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :limit        - How many tags to retrieve. Setting this
+      #                           to 0 will return every tag.
+      #           :page         - The page number.
+      #           :order        - Can be date, count, or name.
+      #           :id           - The id number of the tag.
+      #           :after_id     - Return all tags that have an id number
+      #                           greater than this.
+      #           :name         - The exact name of the tag.
+      #           :name_pattern - Search for any tag that has this
+      #                           parameter in its name.
+      def list_tags(options = {})
+        base_url = '/tag/index'
+        query = query_string(base_url, options)
+        parse(get(query))
+      end
+
+      # Update: This action modifies a specified tag
+      # TODO optional/required args
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :name              - The name of the tag to update.
+      #           :tag[tag_type]     - The tag type. General: 0, artist: 1,
+      #                                copyright: 3, character: 4.
+      #           :tag[is_ambiguous] - Whether or not this tag is
+      #                                ambiguous. Use 1 for true.
+      def update_tag(options = {})
+        base_url = '/tag/update'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      # Related: This action retrieves a list of related tags
+      # TODO optional/required args
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :tags - The tag names to query.
+      #           :type - Restrict results to this tag type (can be
+      #                   general, artist, copyright, or character).
+      def list_related_tags(options = {})
+        base_url = 'tag/related'
+        query = query_string(base_url, options)
+        parse(get(query))
+      end
+
+      alias_method :related_tags, :list_related_tags
+    end
+  end
+end

data/lib/booru/api/user.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+module Booru
+  module API
+    module User
+
+      # Search: This action retrieves a user
+      #
+      # If you don't specify any parameters you'll get a listing of all
+      # users.
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :id   - The id number of the user (optional).
+      #           :name - The name of the user (optional).
+      def search_users(options = {})
+        base_url = '/user/index'
+        query = query_string(base_url, options)
+        parse(get(query))
+      end
+    end
+  end
+end

data/lib/booru/api/wiki.rb

@@ -0,0 +1,136 @@
+# -*- encoding : utf-8 -*-
+module Booru
+  module API
+    module Wiki
+
+      # List: This action retrieves a list of wiki pages.
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :order - How you want the pages ordered. Can be: title,
+      #                    date.
+      #           :limit - The number of pages to retrieve.
+      #           :page  - The page number.
+      #           :query - A word or phrase to search for.
+      def list_wiki_pages(options = {})
+        base_url = '/wiki/index'
+        query = query_string(base_url, options)
+        parse(get(query))
+      end
+
+      # Create: This action creates a wiki page
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :wiki_page[title] - The title of the wiki page.
+      #           :wiki_page[body]  - The body of the wiki page.
+      #
+      # Title must be exact (but case and whitespace don't matter).
+      def create_wiki_page(options = {})
+        base_url = '/wiki/create'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      # Update: This action updates a wiki page
+      #
+      # Title must be exact (but case and whitespace don't matter).
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :title            - The title of the wiki page to update.
+      #           :wiki_page[title] - The new title of the wiki page.
+      #           :wiki_page[body]  - The new body of the wiki page.
+      #
+      # Potential error reasons: "Page is locked"
+      def update_wiki_page(options = {})
+        base_url = '/wiki/update'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      # Show: This action retrieves a wiki page
+      #
+      # Title must be exact (but case and whitespace don't matter).
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :title   - The title of the wiki page to retrieve.
+      #           :version - The version of the page to retrieve.
+      #
+      # Potential error reasons: "artist type"
+      def show_wiki_page(options = {})
+        base_url = '/wiki/show'
+        query = query_string(base_url, options)
+        parse(get(query))
+      end
+
+      # Destroy: This action deletes a wiki page
+      #
+      # Title must be exact (but case and whitespace don't matter).
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :title - The title of the page to delete.
+      #
+      # You must be logged in as a moderator to use this action.
+      def destroy_wiki_page(options = {})
+        base_url = '/wiki/destroy'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      alias_method :delete_wiki_page, :destroy_wiki_page
+
+      # Lock: This action locks a wiki page from being updated
+      #
+      # Title must be exact (but case and whitespace don't matter).
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :title - The title of the page to lock.
+      #
+      # You must be logged in as a moderator to use this action.
+      def lock_wiki_page(options = {})
+        base_url = '/wiki/lock'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      # Unlock: This action unlocks a wiki page for updating
+      #
+      # Title must be exact (but case and whitespace don't matter).
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :title - The title of the page to unlock.
+      #
+      # You must be logged in as a moderator to use this action.
+      def unlock_wiki_page(options = {})
+        base_url = '/wiki/unlock'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      # Revert: This action reverts a wiki page to a previous version
+      #
+      # Title must be exact (but case and whitespace don't matter).
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :title   - The title of the wiki page to update.
+      #           :version - The version to revert to.
+      #
+      # Potential error reasons: "Page is locked"
+      def revert_wiki_page(options = {})
+        base_url = '/wiki/revert'
+        query = query_string(base_url, options)
+        parse(post(query))
+      end
+
+      # History: This action retrieves versions of the specified wiki page
+      #
+      # Title must be exact (but case and whitespace don't matter).
+      #
+      # options - The Hash used to refine the selection (default: {}):
+      #           :title - The title of the wiki page to retrieve history.
+      def wiki_page_history(options = {})
+        base_url = '/wiki/history'
+        query = query_string(base_url, options)
+        parse(get(query))
+      end
+    end
+  end
+end