croudia 1.0.15 → 1.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: ba8b2c711483759304f9c6e9d3142c595ba5f8fc
-  data.tar.gz: 2b00fe7aa4eed970cedfc9175bd3d49c0bdc1baf
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWQ4YmRkODRiMGQxYTkyM2Q5ZDQ3MGUxMjY3ZmIxNWYwNmU3ZTkwMA==
+  data.tar.gz: !binary |-
+    MzVkY2I2N2NhZjhmMDhlNGUyODg3Y2FmMGNkNjYxMzc0ODRmYzg3Mw==
 SHA512:
-  metadata.gz: 724038816211fd2537c9cc8cbfe00d4476d58f4444318964d7d821f7c5faa15d5e5716358ac52f4155ae932ce64be48b46c3506ab95d3f5b7469b0060316712a
-  data.tar.gz: ea16c2207d4eae82ee7d1261f6047f7c7cad0dc2e01b647b2629877977347953b85cebacac57e352868f844505c17963efe927918858d2403fe7870a4bf3a76a
+  metadata.gz: !binary |-
+    MTU5MzU5ZWVjMjZiMjJiOTEzMzUwZTcyZmFhNjhkODcyM2VkNTc0ZjgxMWQw
+    OWY1YWY4MDM2YmMxOTFiMWI0NzhjMTc3MDVmMWYyNTg5OTBlOTYxYjJiYTY0
+    ZmU0ZWJmZTBlNzkyNGM5YzEwYmIzOTcyZGVjYzFmMTc5YmM2MmI=
+  data.tar.gz: !binary |-
+    MWY1MjI4OGJiZWNjOTRhZDk4MTAyNTEzMDg2YWIwYTVkYjQ1ZWY3YTYxODVl
+    MjM0M2IyNmNiOGU2OGUzMDA4YTdkMmU4ZGU2YThkM2VkOGRlNWE3ZGY4Yzdk
+    OGE1NzlkOTkwNjUyNjQ0Njg2ZjIxMDNjNDZmMmZlMDM4MTk1Y2U=

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .env
+.rbenv-vars
 .yardoc
 Gemfile.lock
 InstalledFiles

data/README.md

@@ -11,7 +11,7 @@ Croudia is a registered trademark of Croudia Inc. in Japan.
 
 Add this line to your application's Gemfile:
 
-    gem 'croudia'
+    gem "croudia", "~> 1.0"
 
 And then execute:
 
@@ -66,6 +66,9 @@ home_timeline = croudia.home_timeline
 posted_status = croudia.update("Hello!")
 ```
 
+The full documentation of `Croudia::Client` is available at:
+http://rdoc.info/gems/croudia/Croudia/Client
+
 ## Contributing
 
 1. Fork it

data/lib/croudia/api/account.rb

@@ -5,7 +5,8 @@ module Croudia
     module Account
       # Retrieve the Authenticated User
       #
-      # @params params [Hash] Additional params
+      # @see https://developer.croudia.com/docs/35_account_verify_credentials
+      # @param [Hash] params Additional query parameterss
       # @return [Croudia::User] Current user's object
       def verify_credentials(params={})
         resp = get('/account/verify_credentials.json', params)
@@ -15,9 +16,14 @@ module Croudia
 
       # Update profile image
       #
-      # @param image [File] New profile image
-      # @param params [Hash]
-      # @return [Croudia::User] Authenticated user object with new image
+      # @see https://developer.croudia.com/docs/36_account_update_profile_image
+      # @overload update_profile_image(image, params={})
+      #   @param [File] image New profile image
+      #   @param [Hash] params Addtional query parameters
+      # @overload update_profile_image(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [File] :image New profile image
+      # @return [Croudia::User] Current user's object updated
       def update_profile_image(image, params={})
         merge_file!(params, image, :image)
         resp = post('/account/update_profile_image.json', params)
@@ -26,7 +32,12 @@ module Croudia
 
       # Update profile
       #
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/37_account_update_profile
+      # @param [Hash] params Additional query parameters
+      # @option params [String] :description Bio of the user
+      # @option params [String] :location Geo location
+      # @option params [String] :name Name of the user
+      # @option params [String] :url URL
       # @return [Croudia::User] Updated profile
       def update_profile(params)
         resp = post('/account/update_profile.json', params)

data/lib/croudia/api/favorites.rb

@@ -5,25 +5,24 @@ module Croudia
     module Favorites
       # List of favorited statuses
       #
-      # @param user [String]
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/51_favorites
+      # @param [Hash] params Additional query parameters
+      # @option params [String, Integer] :count Number of statuses in the response
+      # @option params [String] :include_entities Set false to exclude entities
+      # @option params [String, Integer] :max_id Paging parameter
+      # @option params [String, Integer] :since_id Paging parameter
       # @return [Array<Croudia::Status>]
-      def favorites(user={}, params={})
-        resp = case user
-        when Hash
-          params.merge!(user)
-          get('/favorites.json', params)
-        else
-          get("/favorites/#{user}.json", params)
-        end
-
+      def favorites(params={})
+        resp = get('/favorites.json', params)
         objects(Croudia::Status, resp)
       end
 
       # Favorite a status
       #
-      # @param status_id [String, Integer, Croudia::Status]
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/52_favorites_create
+      # @param [String, Integer, Croudia::Status] status_id ID of the status to favorite
+      # @param [Hash] params Additional query parameters
+      # @option params [String] :include_entities Set false to exclude entities
       # @return [Croudia::Status] Favorited status
       def favorite(status_id, params={})
         status_id = get_id(status_id)
@@ -33,8 +32,10 @@ module Croudia
 
       # Unfavorite a status
       #
-      # @param status_id [String, Integer, Croudia::Status]
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/53_favorites_destroy
+      # @param [String, Integer, Croudia::Status] status_id ID of the status to unfavorite
+      # @param [Hash] params Additional query parameters
+      # @option params [String] :include_entities Set false to exclude entities
       # @return [Croudia::Status] Unfavorited status
       def unfavorite(status_id, params={})
         status_id = get_id(status_id)

data/lib/croudia/api/friendships.rb

@@ -7,8 +7,14 @@ module Croudia
     module Friendships
       # Follow a user
       #
-      # @param user [String. Integer, Croudia::User]
-      # @param params [Hash] Optional params
+      # @see https://developer.croudia.com/docs/41_friendships_create
+      # @overload follow(user, params={})
+      #   @param [String, Integer, Croudia::User] user User to follow
+      #   @param [Hash] params Additional query parameters
+      # @overload follow(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String] :screen_name Screen name of user to follow
+      #   @option params [String, Integer] :user_id ID of user to follow
       # @return [Croudia::User] Followed user
       def follow(user, params={})
         merge_user!(params, user)
@@ -18,8 +24,14 @@ module Croudia
 
       # Unfollow a user
       #
-      # @param user [String, Integer, Croudia::User]
-      # @param params
+      # @see https://developer.croudia.com/docs/42_friendships_destroy
+      # @overload unfollow(user, params={})
+      #   @param [String, Integer, Croudia::User] user User to unfollow
+      #   @param [Hash] params Additional query parameters
+      # @overload unfollow(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String] :screen_name Screen name of user to unfollow
+      #   @option params [String, Integer] :user_id ID of user to unfollow
       # @return [Croudia::User] Unfollowed user
       def unfollow(user, params={})
         merge_user!(params, user)
@@ -29,9 +41,17 @@ module Croudia
 
       # Show relationship between two users
       #
-      # @param source [String, Integer, Croudia::User]
-      # @param target [String, Integer, Croudia::User]
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/44_friendships_show
+      # @overload friendship(source, target, params={})
+      #   @param [String, Integer, Croudia::User] source Source of the relationship
+      #   @param [String, Integer, Croudia::User] target Target of the relationship
+      #   @param [Hash] params Additional query parameters
+      # @overload friendship(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String, Integer] :source_id ID of the source user
+      #   @option params [String] :source_screen_name Screen name of the source user
+      #   @option params [String, Integer] :target_id ID of the target user
+      #   @option params [String] :target_screen_name Screen name of the target user
       # @return [Croudia::Relationship]
       def friendship(source, target={}, params={})
         merge_user!(params, source, :source_screen_name, :source_id)
@@ -40,10 +60,16 @@ module Croudia
         Croudia::Relationship.new(resp)
       end
 
-      # Lookup Friendships
+      # Lookup friendships between the current user and others
       #
-      # @param *users [String, Integer, Croudia::User]
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/47_friendships_lookup
+      # @overload friendships(*users, params={})
+      #   @param [String, Integer, Croudia::User] users Users to lookup friendships to them
+      #   @param [Hash] params Additional query parameters
+      # @overload friendships(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String] :screen_name Comma-separated screen names
+      #   @option paramn [String] :user_id Comma-separated user IDs
       # @return [Array<Croudia::User>]
       def friendships(*args)
         merge_users!(params = {}, args)
@@ -53,9 +79,17 @@ module Croudia
 
       # Friend ids of specified user
       #
-      # @param user [String, Integer, Croudia::User]
-      # @param params [Hash]
-      # @return [Croudia::Cursor] Cursor object that contains friend ids
+      # @see https://developer.croudia.com/docs/48_friends_ids
+      # @overload friend_ids(user=current_user, params={})
+      #   @param [String, Integer, Croudia::User] user User to look up friends of
+      #   @param [Hash] params Additional query parameters
+      #   @option params [String, Integer] :cursor Cursor number, -1 to get the first page
+      # @overload friend_ids(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String, Integer] :cursor Cursor number, -1 to get the first page
+      #   @option params [String] :screen_name Screen name of the user to look up friends of
+      #   @option params [String, Integer] :user_id ID of the user to look up friends of
+      # @return [Croudia::Cursor<Integer>] Cursor object that contains friend ids
       def friend_ids(user=current_user, params={})
         merge_user!(params, user)
         resp = get('/friends/ids.json', params)
@@ -64,9 +98,17 @@ module Croudia
 
       # Follower ids of specified user
       #
-      # @param user [String, Integer, Croudia::User]
-      # @param params [Hash]
-      # @return [Croudia::Cursor]
+      # @see https://developer.croudia.com/docs/49_followers_ids
+      # @overload follower_ids(user=current_user, params={})
+      #   @param [String, Integer, Croudia::User] user User to look up followers of
+      #   @param [Hash] params Additional query parameters
+      #   @option params [String, Integer] :cursor Cursor number, -1 to get the first page
+      # @overload follower_ids(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String, Integer] :cursor Cursor number, -1 to get the first page
+      #   @option params [String] :screen_name Screen name of the user to look up followers of
+      #   @option params [String, Integer] :user_id ID of the user to look up followers of
+      # @return [Croudia::Cursor<Integer>] Cursor object that contains follower ids
       def follower_ids(user=current_user, params={})
         merge_user!(params, user)
         resp = get('/followers/ids.json', params)
@@ -75,9 +117,19 @@ module Croudia
 
       # Friends of specified user
       #
-      # @param user [String, Integer, Croudia::User]
-      # @param params [Hash]
-      # @return [Croudia::Cursor]
+      # @see https://developer.croudia.com/docs/40_friends_list
+      # @overload friends(user=current_user, params={})
+      #   @param [String, Integer, Croudia::User] user User to look up friends of
+      #   @param [Hash] params Additional query parameters
+      #   @option params [String, Integer] :cursor Cursor number, -1 to get the first page
+      #   @option params [String] :trim_user Set true to return compact user objects
+      # @overload friends(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String, Integer] :cursor Cursor number, -1 to get the first page
+      #   @option params [String] :screen_name Screen name of the user to look up friends of
+      #   @option params [String] :trim_user Set true to return compact user objects
+      #   @option params [String, Integer] :user_id ID of the user to look up friends of
+      # @return [Croudia::Cursor<Croudia::User>] Cursor object that contains friends
       def friends(user=current_user, params={})
         merge_user!(params, user)
         resp = get('/friends/list.json', params)
@@ -86,9 +138,19 @@ module Croudia
 
       # Followers of specified user
       #
-      # @param user [String, Integer, Croudia::User]
-      # @param params [Hash]
-      # @return [Croudia::Cursor]
+      # @see https://developer.croudia.com/docs/43_followers_list
+      # @overload followers(user=current_user, params={})
+      #   @param [String, Integer, Croudia::User] user User to look up followers of
+      #   @param [Hash] params Additional query parameters
+      #   @option params [String, Integer] :cursor Cursor number, -1 to get the first page
+      #   @option params [String] :trim_user Set true to return compact user objects
+      # @overload followers(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String, Integer] :cursor Cursor number, -1 to get the first page
+      #   @option params [String] :screen_name Screen name of the user to look up followers of
+      #   @option params [String] :trim_user Set true to return compact user objects
+      #   @option params [String, Integer] :user_id ID of the user to look up followers of
+      # @return [Croudia::Cursor<Croudia::User>] Cursor object that contains followers
       def followers(user=current_user, params={})
         merge_user!(params, user)
         resp = get('/followers/list.json', params)

data/lib/croudia/api/oauth.rb

@@ -5,7 +5,12 @@ module Croudia
     module OAuth
       # Authorize URL
       #
-      # @return authorize_url [String]
+      # @see https://developer.croudia.com/docs/oauth
+      # @param [Hash] params Query parameters
+      # @option params [String] :client_id (@client_id) OAuth client ID
+      # @option params [String] :response_type ("code") OAuth response type
+      # @option params [String] :state
+      # @return [String] Authorize URL
       def authorize_url(params={})
         params[:client_id] ||= @client_id
         params[:response_type] ||= 'code'
@@ -14,9 +19,20 @@ module Croudia
 
       # Retrieve access_token
       #
-      # @param code [String] Authorize code passed from user
-      # @params params [Hash] Additional params
-      # @return access_token [Hash]
+      # @see https://developer.croudia.com/docs/oauth
+      # @overload get_access_token(code, params={})
+      #   @param [String] code Authorize code passed from user
+      #   @param [Hash] params Additional query parameters
+      #   @option params [String] :client_id (@client_id) OAuth client ID
+      #   @option params [String] :client_secret (@client_secret) OAuth client secret
+      #   @option params [String] :grant_type ("authorization_code") OAuth grant type
+      # @overload get_access_token(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String] :client_id (@client_id) OAuth client ID
+      #   @option params [String] :client_secret (@client_secret) OAuth client secret
+      #   @option params [String] :code Code param passed from user
+      #   @option params [String] :grant_type ("authorization_code") OAuth grant type
+      # @return [Croudia::AccessToken] Access token
       def get_access_token(code, params={})
         case code
         when String, Integer

data/lib/croudia/api/search.rb

@@ -6,8 +6,23 @@ module Croudia
     module Search
       # Search for statuses
       #
-      # @param q [String] Search query
-      # @param params [Hash] Optional params
+      # @see https://developer.croudia.com/docs/81_search
+      # @overload search(q, params={})
+      #   @param [String] q Search query
+      #   @param [Hash] params Additional query parameters
+      #   @option params [String, Integer] :count Number of statuses in the response
+      #   @option params [String] :include_entities Set false to exclude entities
+      #   @option params [String, Integer] :max_id Paging parameter
+      #   @option params [String, Integer] :since_id Paging parameter
+      #   @option params [String] :trim_user Set true to return compact user objects
+      # @overload search(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String] :q Search query
+      #   @option params [String, Integer] :count Number of statuses in the response
+      #   @option params [String] :include_entities Set false to exclude entities
+      #   @option params [String, Integer] :max_id Paging parameter
+      #   @option params [String, Integer] :since_id Paging parameter
+      #   @option params [String] :trim_user Set true to return compact user objects
       # @return [Croudia::SearchResults]
       def search(q, params={})
         merge_query!(params, q)
@@ -17,14 +32,28 @@ module Croudia
 
       # Search for users
       #
-      # @param q [String] Search query
-      # @param params [Hash] Optional params
-      # @return [Array<Croudia::User>]
+      # @see https://developer.croudia.com/docs/82_users_search
+      # @overload search_user(q, params={})
+      #   @param [String] q Search query
+      #   @param [Hash] params Additional query parameters
+      #   @option params [String, Integer] :count Number of users in the response
+      #   @option params [String] :include_entities Set false to exclude entities
+      #   @option params [String, Integer] :max_id Paging parameter
+      #   @option params [String, Integer] :since_id Paging parameter
+      #   @option params [String] :trim_user Set true to return compact user objects
+      # @overload search_user(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String] :q Search query
+      #   @option params [String, Integer] :count Number of users in the response
+      #   @option params [String, Integer] :page Page to fetch, up to 1000
+      #   @option params [String] :trim_user Set true to return compact user objects
+      # @return [Array<Croudia::User>] Users found
       def search_user(q, params={})
         merge_query!(params, q)
         resp = get('/users/search.json', params)
         objects(Croudia::User, resp)
       end
+      alias search_users search_user
     end
   end
 end

data/lib/croudia/api/secret_mails.rb

@@ -5,8 +5,12 @@ module Croudia
     module SecretMails
       # Get incoming secret mails
       #
-      # @param params [Hash]
-      # @return [Array<Croudia::SecretMails>]
+      # @see https://developer.croudia.com/docs/21_secret_mails
+      # @param [Hash] params Additional query parameters
+      # @option params [String, Integer] :count Number of secret mails in the response
+      # @option params [String, Integer] :max_id Paging parameter
+      # @option params [String, Integer] :since_id Paging parameter
+      # @return [Array<Croudia::SecretMail>]
       def secret_mails(params={})
         resp = get('/secret_mails.json', params)
         objects(Croudia::SecretMail, resp)
@@ -14,7 +18,11 @@ module Croudia
 
       # Get outgoing secret mails
       #
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/22_secret_mails_sent
+      # @param [Hash] params Additional query parameters
+      # @option params [String, Integer] :count Number of secret mails in the response
+      # @option params [String, Integer] :max_id Paging parameter
+      # @option params [String, Integer] :since_id Paging parameter
       # @return [Array<Croudia::SecretMail>]
       def secret_mails_sent(params={})
         resp = get('/secret_mails/sent.json', params)
@@ -23,9 +31,17 @@ module Croudia
 
       # Send a new secret mail
       #
-      # @param text [String] Message body
-      # @param to_user [String, Integer, Croudia::User] Recipient user
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/23_secret_mails_new
+      # @overload send_secret_mail(text, to_user, params={})
+      #   @param [String] text Message body
+      #   @param [String, Integer, Croudia::User] to_user Recipient user
+      #   @param [Hash] params Additional query parameters
+      # @overload send_secret_mail(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String] :screen_name Screen name of the recipient
+      #   @option params [String] :text Message body
+      #   @option params [String, Integer] :user_id ID of the recipient
+      # @return [Croudia::SecretMail] Sent message
       def send_secret_mail(text, to_user={}, params={})
         merge_text!(params, text, :text)
         merge_user!(params, to_user)
@@ -36,9 +52,10 @@ module Croudia
 
       # Destroy a secret mail
       #
-      # @param id [Integer, String, Croudia::SecretMail]
-      # @param params [Hash]
-      # @return [Croudia::SecretMail]
+      # @see https://developer.croudia.com/docs/24_secret_mails_destroy
+      # @param [String, Integer, Croudia::SecretMail] id ID of the secret mail to delete
+      # @param [Hash] params Additional query params
+      # @return [Croudia::SecretMail] Deleted secret mail
       def destroy_secret_mail(id, params={})
         resp = post("/secret_mails/destroy/#{get_id(id)}.json", params)
         Croudia::SecretMail.new(resp)
@@ -46,8 +63,9 @@ module Croudia
 
       # Get a secret mail
       #
-      # @param id [Integer, String, Croudia::SecretMail]
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/25_secret_mails_show
+      # @param [String, Integer, Croudia::SecretMail] id ID of the secret mail to get
+      # @param [Hash] params Additional query parameters
       # @return [Croudia::SecretMail]
       def show_secret_mail(id, params={})
         resp = get("/secret_mails/show/#{get_id(id)}.json", params)