croudia 1.0.15 → 1.1.0

data/lib/croudia/api/statuses.rb

@@ -5,11 +5,24 @@ module Croudia
     module Statuses
       # Update status
       #
-      # @param status [String] Status text
-      # @param params [Hash] Additional params
-      # @return status [Croudia::Status] Posted status
-      def update(text, params={})
-        merge_text!(params, text)
+      # @see https://developer.croudia.com/docs/11_statuses_update
+      # @overload update(status, params={})
+      #   @param [String] status Status text
+      #   @param [Hash] params Additional query parameters
+      #   @option params [String, Integer] :in_reply_to_status_id
+      #   @option params [String] :in_reply_with_quote Set true if quote
+      #   @option params [String] :include_entities Set false to exclude entities
+      #   @option params [String] :trim_user Set true to return compact user objects
+      # @overload update(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String, Integer] :in_reply_to_status_id
+      #   @option params [String] :in_reply_with_quote Set true if quote
+      #   @option params [String] :include_entities Set false to exclude entities
+      #   @option params [String] :status Status text
+      #   @option params [String] :trim_user Set true to return compact user objects
+      # @return [Croudia::Status] Posted status
+      def update(status, params={})
+        merge_text!(params, status)
 
         resp = post('/statuses/update.json', params)
         Croudia::Status.new(resp)
@@ -17,8 +30,23 @@ module Croudia
 
       # Update status with media
       #
-      # @param status [String] Status text
-      # @param media [File] Image to upload with
+      # @see https://developer.croudia.com/docs/14_statuses_update_with_media
+      # @note Currently only PNG, JPG, and GIF are supported
+      # @overload update_with_media(status, media, params={})
+      #   @param [String] status Status text
+      #   @param [File, #to_io] media Image to upload with
+      #   @option params [String, Integer] :in_reply_to_status_id
+      #   @option params [String] :in_reply_with_quote Set true if quote
+      #   @option params [String] :include_entities Set false to exclude entities
+      #   @option params [String] :trim_user Set true to return compact user objects
+      # @overload update_with_media(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String, Integer] :in_reply_to_status_id
+      #   @option params [String] :in_reply_with_quote Set true if quote
+      #   @option params [String] :include_entities Set false to exclude entities
+      #   @option params [File, #to_io] media Image to upload with
+      #   @option params [String] :status Status text
+      #   @option params [String] :trim_user Set true to return compact user objects
       # @return [Croudia::Status]
       def update_with_media(status, media={}, params={})
         merge_text!(params, status)
@@ -29,33 +57,42 @@ module Croudia
 
       # Destroy a status
       #
-      # @param status_id [String, Integer, Croudia::Status] Status to delete
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/12_statuses_destroy
+      # @param [String, Integer, Croudia::Status] status Status to delete
+      # @param [Hash] params Additional query parameters
+      # @option params [String] :include_entities Set false to exclude entities
+      # @option params [String] :trim_user Set true to return compact user objects
       # @return [Croudia::Status] Deleted status
-      def destroy_status(status_id, params={})
-        status_id = get_id(status_id)
+      def destroy_status(status, params={})
+        status_id = get_id(status)
         resp = post("/statuses/destroy/#{status_id}.json", params)
         Croudia::Status.new(resp)
       end
 
       # Retrieve a status
       #
-      # @param status_id [String, Integer, Croudia::Status]
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/13_statuses_show
+      # @param [String, Integer, Croudia::Status] status Status to get
+      # @param [Hash] params Additional query parameters
+      # @option params [String] :include_entities Set false to exclude entities
+      # @option params [String] :trim_user Set true to return compact user objects
       # @return [Croudia::Status]
-      def status(status_id, params={})
-        status_id = get_id(status_id)
+      def status(status, params={})
+        status_id = get_id(status)
         resp = get("/statuses/show/#{status_id}.json", params)
         Croudia::Status.new(resp)
       end
 
       # Spread a status
       #
-      # @param status_id [String, Integer, Croudia::Status] Status to spread
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/61_statuses_spread
+      # @param [String, Integer, Croudia::Status] status Status to spread
+      # @param [Hash] params Additional query parameters
+      # @option params [String] :include_entities Set false to exclude entities
+      # @option params [String] :trim_user Set true to return compact user objects
       # @return [Croudia::Status] My status including spreaded status
-      def spread(status_id, params={})
-        status_id = get_id(status_id)
+      def spread(status, params={})
+        status_id = get_id(status)
         resp = post("/statuses/spread/#{status_id}.json", params)
         Croudia::Status.new(resp)
       end

data/lib/croudia/api/timelines.rb

@@ -5,7 +5,13 @@ module Croudia
     module Timelines
       # Public Timeline
       #
-      # @param params [Hash] Additional params
+      # @see https://developer.croudia.com/docs/01_statuses_public_timeline
+      # @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
       # @return [Array<Croudia::Status>]
       def public_timeline(params={})
         resp = get('/statuses/public_timeline.json', params)
@@ -14,7 +20,13 @@ module Croudia
 
       # Home Timeline
       #
-      # @params params [Hash]
+      # @see https://developer.croudia.com/docs/02_statuses_home_timeline
+      # @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
       # @return [Array<Croudia::Status>]
       def home_timeline(params={})
         resp = get('/statuses/home_timeline.json', params)
@@ -23,15 +35,41 @@ module Croudia
 
       # User Timeline
       #
-      # @param user [String, Integer, Croudia::User]
-      # @param params [Hash]
-      # @return [Array<Croudia::Status>
+      # @see https://developer.croudia.com/docs/03_statuses_user_timeline
+      # @overload user_timeline(user, params={})
+      #   @param [String, Integer, Croudia::User] user
+      #   @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 user_timeline(params={})
+      #   @param [Hash] params 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] :screen_name Screen name of the user
+      #   @option params [String, Integer] :since_id Paging parameter
+      #   @option params [String] :trim_user Set true to return compact user objects
+      #   @option params [String, Integer] :user_id ID of the user
+      # @return [Array<Croudia::Status>]
       def user_timeline(user, params={})
         merge_user!(params, user)
         resp = get('/statuses/user_timeline.json', params)
         objects(Croudia::Status, resp)
       end
 
+      # Mentions
+      #
+      # @see https://developer.croudia.com/docs/04_statuses_mentions
+      # @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
+      # @return [Array<Croudia::Status>]
       def mentions(params={})
         resp = get('/statuses/mentions.json', params)
         objects(Croudia::Status, resp)

data/lib/croudia/api/trends.rb

@@ -0,0 +1,20 @@
+require 'croudia/trend'
+require 'croudia/trend_results'
+
+module Croudia
+  module API
+    module Trends
+      # Retrieve the current trends
+      #
+      # @see https://developer.croudia.com/docs/100_trends_place
+      # @param [Hash] params Query parameters
+      # @option params [String, Integer] :id ("1") Location ID
+      # @return [Croudia::TrendResults<Croudia::Trend>]
+      def trends(params={})
+        params[:id] ||= '1'
+        resp = get('/trends/place.json', params)
+        Croudia::TrendResults.new(resp)
+      end
+    end
+  end
+end

data/lib/croudia/api/users.rb

@@ -5,8 +5,14 @@ module Croudia
     module Users
       # Retrieve a user
       #
-      # @param user [String, Integer, Croudia::User]
-      # @param params [Hash] Optional params
+      # @see https://developer.croudia.com/docs/31_users_show
+      # @overload user(user, params={})
+      #   @param [String, Integer, Croudia::User] user
+      #   @param [Hash] params Additional query parameters
+      # @overload user(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String] :screen_name Screen name of the user
+      #   @option params [String, Integer] :user_id ID of the user
       # @return [Croudia::User]
       def user(user, params={})
         merge_user!(params, user)
@@ -16,8 +22,14 @@ module Croudia
 
       # Lookup Users
       #
-      # @param *users [String, Integer, Croudia::User]
-      # @param params [Hash]
+      # @see https://developer.croudia.com/docs/32_users_lookup
+      # @overload users(*users, params={})
+      #   @param [String, Integer, Croudia::User] users
+      #   @param [Hash] params Additional query parameters
+      # @overload users(params={})
+      #   @param [Hash] params Query parameters
+      #   @option params [String] :screen_name Comma-separated screen names
+      #   @option params [String] :user_id Comma-separated user IDs
       # @return [Array<Croudia::User>]
       def users(*args)
         merge_users!(params = {}, args)

data/lib/croudia/base.rb

@@ -1,71 +1,71 @@
-module Croudia
-  class Base
-    class << self
-      def attr_reader(*attrs)
-        attrs.each do |attr|
-          define_method(attr) do
-            @attrs[attr.to_s] || @attrs[attr.to_sym]
-          end
-        end
-      end
-
-      # @param attrs [Hash] { name: Class, name: Class, ... }
-      def attr_object_reader(attrs)
-        attrs.each_pair do |path, klass|
-          path = [path] unless path.is_a?(Array)
-          attr = path.join('_').to_sym
-
-          define_method(path.last) do
-            object = instance_variable_get("@#{attr}")
-
-            unless object
-              object_attrs = @attrs
-              path.each { |p| object_attrs = object_attrs[p.to_s] }
-
-              object = if object_attrs.nil?
-                nil
-              elsif klass.is_a?(Array)
-                klass = klass.shift
-                object_attrs.map { |o| klass.new(o) }
-              else
-                klass.new(object_attrs)
-              end
-
-              instance_variable_set("@#{attr}", object)
-            end
-
-            object
-          end
-        end
-      end
-    end
-
-    # Initialize a new object
-    #
-    # @param attrs [Hash]
-    # @return [Croudia::Base]
-    def initialize(attrs = {})
-      @attrs = attrs || {}
-    end
-
-    # Fetch an attribute
-    #
-    # @param name [String, Symobol]
-    def [](name)
-      __send__(name.to_sym)
-    rescue NoMethodError
-      nil
-    end
-    
-    # @return [Hash]
-    def attrs
-      @attrs
-    end
-    alias to_h attrs
-    alias to_hash attrs
-
-    def inspect
-      "#<#{self.class}:0x#{__id__.abs.to_s(16)} #{@attrs.inspect}>"
-    end
-  end
-end
+module Croudia
+  class Base
+    class << self
+      def attr_reader(*attrs)
+        attrs.each do |attr|
+          define_method(attr) do
+            @attrs[attr.to_s] || @attrs[attr.to_sym]
+          end
+        end
+      end
+
+      # @param [Hash] attrs { name: Class, name: Class, ... }
+      def attr_object_reader(attrs)
+        attrs.each_pair do |path, klass|
+          path = [path] unless path.is_a?(Array)
+          attr = path.join('_').to_sym
+
+          define_method(path.last) do
+            object = instance_variable_get("@#{attr}")
+
+            unless object
+              object_attrs = @attrs
+              path.each { |p| object_attrs = object_attrs[p.to_s] }
+
+              object = if object_attrs.nil?
+                nil
+              elsif klass.is_a?(Array)
+                klass = klass.shift
+                object_attrs.map { |o| klass.new(o) }
+              else
+                klass.new(object_attrs)
+              end
+
+              instance_variable_set("@#{attr}", object)
+            end
+
+            object
+          end
+        end
+      end
+    end
+
+    # Initialize a new object
+    #
+    # @param [Hash] attrs
+    # @return [Croudia::Base]
+    def initialize(attrs = {})
+      @attrs = attrs
+    end
+
+    # Fetch an attribute
+    #
+    # @param [String, Symobol] name
+    def [](name)
+      __send__(name.to_sym)
+    rescue NoMethodError
+      nil
+    end
+
+    # @return [Hash]
+    def attrs
+      @attrs
+    end
+    alias to_h attrs
+    alias to_hash attrs
+
+    def inspect
+      "#<#{self.class}:0x#{__id__.abs.to_s(16)} #{@attrs.inspect}>"
+    end
+  end
+end

data/lib/croudia/client.rb

@@ -6,10 +6,10 @@ require 'croudia/api/search'
 require 'croudia/api/secret_mails'
 require 'croudia/api/statuses'
 require 'croudia/api/timelines'
+require 'croudia/api/trends'
 require 'croudia/api/users'
 require 'croudia/api/utils'
 require 'croudia/configurable'
-require 'croudia/ext/openssl'
 require 'croudia/version'
 require 'faraday'
 
@@ -23,14 +23,14 @@ module Croudia
     include Croudia::API::SecretMails
     include Croudia::API::Statuses
     include Croudia::API::Timelines
+    include Croudia::API::Trends
     include Croudia::API::Users
     include Croudia::API::Utils
     include Croudia::Configurable
 
     # Initialize a new Client object
     #
-    # @param options [Hash]
-    # @return [Croudia::Client]
+    # @param [Hash] options
     def initialize(options={})
       Croudia::Configurable.keys.each do |key|
         instance_variable_set(:"@#{key}", options[key] || Croudia.instance_variable_get(:"@#{key}"))
@@ -59,6 +59,7 @@ module Croudia
 
   private
 
+    # @return [String] Response body
     def request(method, path, params={})
       connection.send(method.to_sym, path, params) do |request|
         request.headers[:authorization] = "Bearer #{@access_token}" if @access_token

data/lib/croudia/creatable.rb

@@ -2,6 +2,7 @@ require 'time'
 
 module Croudia
   module Creatable
+    # @return [Time]
     def created_at
       @created_at ||= Time.parse(@attrs['created_at'])
     end

data/lib/croudia/default.rb

@@ -1,70 +1,70 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'croudia/configurable'
-require 'croudia/request/multipart_with_file'
-require 'croudia/request/raise_error'
-require 'croudia/response/parse_json'
-require 'croudia/response/raise_error'
-require 'croudia/version'
-
-module Croudia
-  module Default
-    ENDPOINT = 'https://api.croudia.com' unless defined? Croudia::Default::ENDPOINT
-    CONNECTION_OPTIONS = {
-      headers: {
-        accept: 'application/json',
-        user_agent: "Croudia Ruby Gem/#{Croudia::VERSION}",
-      },
-      request: {
-        open_timeout: 10,
-        timeout: 30,
-      },
-      ssl: {
-        verify: true,
-      },
-    } unless defined? Croudia::Default::CONNECTION_OPTIONS
-    MIDDLEWARE = Faraday::Builder.new do |builder|
-      builder.request :multipart_with_file
-      builder.request :multipart
-      builder.request :url_encoded
-      builder.request :raise_error
-
-      builder.response :raise_error
-      builder.response :parse_json
-
-      builder.adapter Faraday.default_adapter
-    end unless defined? Croudia::Default::MIDDLEWARE
-
-    class << self
-      def options
-        Hash[Croudia::Configurable.keys.map do |key|
-          [key, __send__(key)]
-        end]
-      end
-
-      def client_id
-        ENV['CROUDIA_CLIENT_ID']
-      end
-
-      def client_secret
-        ENV['CROUDIA_CLIENT_SECRET']
-      end
-
-      def access_token
-        ENV['CROUDIA_ACCESS_TOKEN']
-      end
-
-      def endpoint
-        ENDPOINT
-      end
-
-      def connection_options
-        CONNECTION_OPTIONS
-      end
-
-      def middleware
-        MIDDLEWARE
-      end
-    end
-  end
-end
+require 'faraday'
+require 'faraday_middleware'
+require 'croudia/configurable'
+require 'croudia/request/multipart_with_file'
+require 'croudia/request/raise_error'
+require 'croudia/response/parse_json'
+require 'croudia/response/raise_error'
+require 'croudia/version'
+
+module Croudia
+  module Default
+    ENDPOINT = 'https://api.croudia.com' unless defined? Croudia::Default::ENDPOINT
+    CONNECTION_OPTIONS = {
+      headers: {
+        accept: 'application/json',
+        user_agent: "Croudia Ruby Gem/#{Croudia::VERSION}",
+      },
+      request: {
+        open_timeout: 10,
+        timeout: 30,
+      },
+      ssl: {
+        verify: true,
+      },
+    } unless defined? Croudia::Default::CONNECTION_OPTIONS
+    MIDDLEWARE = Faraday::Builder.new do |builder|
+      builder.request :multipart_with_file
+      builder.request :multipart
+      builder.request :url_encoded
+      builder.request :raise_error
+
+      builder.response :raise_error
+      builder.response :parse_json
+
+      builder.adapter Faraday.default_adapter
+    end unless defined? Croudia::Default::MIDDLEWARE
+
+    class << self
+      def options
+        Hash[Croudia::Configurable.keys.map do |key|
+          [key, __send__(key)]
+        end]
+      end
+
+      def client_id
+        ENV['CROUDIA_CLIENT_ID']
+      end
+
+      def client_secret
+        ENV['CROUDIA_CLIENT_SECRET']
+      end
+
+      def access_token
+        ENV['CROUDIA_ACCESS_TOKEN']
+      end
+
+      def endpoint
+        ENDPOINT
+      end
+
+      def connection_options
+        CONNECTION_OPTIONS
+      end
+
+      def middleware
+        MIDDLEWARE
+      end
+    end
+  end
+end