twitter_api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a3db3bf69e15b1348027a86ef3ae6858278bede
-  data.tar.gz: 232a03167de774f62b18e49b78479801e10666db
+  metadata.gz: 43a114e1feb00e8dd32a91acbd0903359e89d87d
+  data.tar.gz: f703b82e78be5ded9331bcc92cb6d269d4f4a5f5
 SHA512:
-  metadata.gz: 17a2249100fca19646803041a5b4ce2590a22a00764b979ccb73ffd560dd70f3d6623c4dd02dcac13c3cd315d96848ac6b9ae3189f6d9a2b94039bd270bc1667
-  data.tar.gz: a925350474fb0fae452f47fff15c4ce74a459e9e7852615cfa2e7d3866929669807f5b43860c583d4a1f91b2a1fa5e641737bd0b17cced116a1f99525daa28eb
+  metadata.gz: 3be34676bc85d29da9741dafd1241ab8e392a8c5d367f4365d5259de5db9c5e9e8045635c663493eca42472d24ddb5aa23e68eb90dfe18cc332c22b23a937910
+  data.tar.gz: f7a3be2567eab539b68fa9d5115506023f98e2d97b4596f0b264041e305523ca7ad172959656baa29fc927e8bd595cbae73e8f085b5a6ed7ca54958c90aea5cd

data/README.md

@@ -34,7 +34,7 @@ t = TwitterAPI::Client.new({
 
 # call GET statuses/user_timeline
 res = t.get('https://api.twitter.com/1.1/statuses/user_timeline.json', {
-  'screen_name' => 'niwasawa',
+  'screen_name' => 'YOUR_SCREEN_NAME',
   'count' => '1'
 })
 puts res.headers
@@ -42,7 +42,7 @@ puts JSON.pretty_generate(JSON.parse(res.body))
 
 # call GET statuses/user_timeline
 res = t.statuses_user_timeline({
-  'screen_name' => 'niwasawa',
+  'screen_name' => 'YOUR_SCREEN_NAME',
   'count' => '1'
 })
 puts res.headers
@@ -61,17 +61,13 @@ res = t.statuses_update({
 })
 puts res.headers
 puts JSON.pretty_generate(JSON.parse(res.body))
-
-# call GET statues/mention_timeline
-res = t.statuses_mentions_timeline({
-  'count' => '1'
-})
-puts res.headers
-puts JSON.pretty_generate(JSON.parse(res.body))
 ```
 
 ## Documentation
 
+Documentation for twitter_api
+http://www.rubydoc.info/gems/twitter_api/
+
 Reference Documentation — Twitter Developers
 https://dev.twitter.com/rest/reference
 

data/lib/twitter_api.rb

@@ -5,30 +5,41 @@ require 'open-uri'
 require 'simple_oauth'
 
 # Twitter API Ruby thin client wrapper library
+# {https://github.com/niwasawa/twitter-api-ruby-thin-client-wrapper}
 module TwitterAPI
 
+  # A client class.
   class Client
 
+    # Initializes a Client object.
+    #
+    # @param credentials [Hash] Credentials
+    # @return [TwitterAPI::Client]
     def initialize(credentials)
       @credentials = credentials
     end
 
-    def authorization(method, url, params)
-      SimpleOAuth::Header.new(method, url, params, @credentials).to_s
-    end
-
-    # @return StringIO or Tempfile
-    def get(base_url, params)
-      headers = {'Authorization' => authorization('GET', base_url, params)}
-      url = base_url + '?' + URI.encode_www_form(params)
+    # Calls a Twitter REST API using GET method.
+    #
+    # @param resource_url [String] Resource URL
+    # @param params [Hash] Parameters
+    # @return [TwitterAPI::Response]
+    def get(resource_url, params)
+      headers = {'Authorization' => authorization('GET', resource_url, params)}
+      url = resource_url + '?' + URI.encode_www_form(params)
       res = open(url, headers)
       Response.new(res)
     end
 
-    # @return Net::HTTPResponse
-    def post(base_url, params, data=nil)
-      headers = {'Authorization' => authorization('POST', base_url, params)}
-      url = base_url + '?' + URI.encode_www_form(params)
+    # Calls a Twitter REST API using POST method.
+    #
+    # @param resource_url [String] Resource URL
+    # @param params [Hash] Parameters
+    # @param data [String] Posts data
+    # @return [TwitterAPI::Response]
+    def post(resource_url, params, data=nil)
+      headers = {'Authorization' => authorization('POST', resource_url, params)}
+      url = resource_url + '?' + URI.encode_www_form(params)
       uri = URI.parse(url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
@@ -37,55 +48,91 @@ module TwitterAPI
       Response.new(res)
     end
 
-    # GET search/tweets — Twitter Developers
-    # https://dev.twitter.com/rest/reference/get/search/tweets
+    # GET search/tweets
+    # {https://dev.twitter.com/rest/reference/get/search/tweets}
+    #
+    # @param params [Hash] Parameters
+    # @return [TwitterAPI::Response]
     def search_tweets(params)
-      base_url = 'https://api.twitter.com/1.1/search/tweets.json'
-      get(base_url, params)
+      resource_url = 'https://api.twitter.com/1.1/search/tweets.json'
+      get(resource_url, params)
     end
 
-    # GET statuses/mentions_timeline — Twitter Developers
-    # https://dev.twitter.com/rest/reference/get/statuses/mentions_timeline
+    # GET statuses/mentions_timeline
+    # {https://dev.twitter.com/rest/reference/get/statuses/mentions_timeline}
+    #
+    # @param params [Hash] Parameters
+    # @return [TwitterAPI::Response]
     def statuses_mentions_timeline(params)
-      base_url = 'https://api.twitter.com/1.1/statuses/mentions_timeline.json'
-      get(base_url, params)
+      resource_url = 'https://api.twitter.com/1.1/statuses/mentions_timeline.json'
+      get(resource_url, params)
     end
 
-    # GET statuses/user_timeline — Twitter Developers
-    # https://dev.twitter.com/rest/reference/get/statuses/user_timeline
+    # GET statuses/user_timeline
+    # {https://dev.twitter.com/rest/reference/get/statuses/user_timeline}
+    #
+    # @param params [Hash] Parameters
+    # @return [TwitterAPI::Response]
     def statuses_user_timeline(params)
-      base_url = 'https://api.twitter.com/1.1/statuses/user_timeline.json'
-      get(base_url, params)
+      resource_url = 'https://api.twitter.com/1.1/statuses/user_timeline.json'
+      get(resource_url, params)
     end
 
-    # POST statuses/update — Twitter Developers
-    # https://dev.twitter.com/rest/reference/post/statuses/update
+    # POST statuses/update
+    # {https://dev.twitter.com/rest/reference/post/statuses/update}
+    #
+    # @param params [Hash] Parameters
+    # @return [TwitterAPI::Response]
     def statuses_update(params)
-      base_url = 'https://api.twitter.com/1.1/statuses/update.json'
-      post(base_url, params)
+      resource_url = 'https://api.twitter.com/1.1/statuses/update.json'
+      post(resource_url, params)
+    end
+
+    private
+
+    # Returns string of authorization.
+    #
+    # @param method [String] A HTTP method
+    # @param url [String] A URL
+    # @param params [Hash] Parameters
+    # @return [String]
+    def authorization(method, url, params)
+      SimpleOAuth::Header.new(method, url, params, @credentials).to_s
     end
+
   end
 
+  # A HTTP Response class.
   class Response
 
+    # Initializes a Response object.
+    #
+    # @param res [StringIO]
+    # @param res [Tempfile]
+    # @return [TwitterAPI::Client]
     def initialize(res)
       @res = res
     end
 
-    # @return Net::HTTPHeader or Hash
+    # Returns HTTP headers.
+    #
+    # @return [Net::HTTPHeader]
+    # @return [Hash]
     def headers
       if @res.kind_of?(Net::HTTPResponse)
-        @res
+        @res # Net::HTTPHeader
       elsif @res.kind_of?(StringIO)
-        @res.meta
+        @res.meta # Hash
       elsif @res.kind_of?(Tempfile)
-        @res.meta
+        @res.meta # Hash
       else
         nil
       end
     end
 
-    # @return String
+    # Returns HTTP body.
+    #
+    # @return [String]
     def body
       if @res.kind_of?(Net::HTTPResponse)
         @res.body

data/lib/twitter_api/version.rb

@@ -1,3 +1,3 @@
 module TwitterAPI
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitter_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Naoki Iwasawa