shixian_weibo_2 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd2179efefd6a862284ec08f43a7a7124f89bd66dc81ad66dcad7471eea74fca
+  data.tar.gz: 621d8fdc267f0c8ee8523b28f836b56679d9137aec52ce86000845a8dae0604c
+SHA512:
+  metadata.gz: 531d8a6f23a02ae182631b63994f3f9086ed5baf30562dfd2d29e3a93dc7368ae891d3ae7c6055e7bef663ab1f6935cb1fc00846666b7ec5e5ff13e0326e4f9f
+  data.tar.gz: 8f3280debf8feb480e6a64c16b3c594af969f67694d808f69d628663e913958eb14b33302c6526ca940fa13642ceadd0c29df315857cff5bd454e89722ce686f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+example/.sass-cache

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 simsicon
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,135 @@
+Note: I got a lot of inspiration from [this gem](https://github.com/ballantyne/weibo) and [this gem](https://github.com/acenqiu/weibo2). The first one will soon be deprecated since weibo is planning to switch to oauth2. The second one has not been fully implemented and is still lacking some features (but a nice try nevertheless). Thanks Scott and acenqiu.
+
+# WeiboOAuth2
+
+WeioOAuth2 is a Ruby gem that provides a wrapper for interacting with sina weibo's v2 [API](http://open.weibo.com/wiki/API%E6%96%87%E6%A1%A3_V2), which is currently the latest version. Check out the link if you are interested in browsing the details. The output data format is Hashie::Mash, check out [here](https://github.com/intridea/hashie#mash). If you are not familiar with oauth2, I recommend that you read this [article](http://open.weibo.com/wiki/%E6%8E%88%E6%9D%83%E6%9C%BA%E5%88%B6%E8%AF%B4%E6%98%8E).
+
+## Requirements
+
+1.  weibo account
+2.  weibo app API key
+3.  weibo app API secret
+
+## Installation
+
+I call it weibo_2 because someone else took the name weibo_oauth2.
+
+```bash
+$ gem install weibo_2
+```
+
+## Basic Usage
+
+The example have been moved to [here](https://github.com/simsicon/weibo_2_example). It wiil be more convenient to update.
+
+The [example](https://github.com/simsicon/weibo_2_example) written with sinatra shows how to ask for oauth2 permission, get the token and send status with picture. It should cover basic usage in all ruby apps. You can run your own demo!
+
+```bash
+$ KEY=change_this_to_your_key SECRET=change_this_to_your_secret REDIR_URI=change_this_to_your_redir_uri ruby example.rb
+```
+It should work.
+
+
+1.  How to get the token?
+
+    OAuth2 is simpler than its first version. In order to get the access token, you first need to get an Authorization Code through a callback request. Now use the following code to get the token.
+
+    ```ruby
+    WeiboOAuth2::Config.api_key = YOUR_KEY
+    WeiboOAuth2::Config.api_secret = YOUR_SECRET
+    WeiboOAuth2::Config.redirect_uri = YOUR_CALLBACK_URL
+    ```
+
+    If you are developing in your localhost, you can set YOUR_CALLBACK_URL as 'http://127.0.0.1/callback' something. Then set your weibo app account's callback URL as this URL too. Weibo will call the URL using GET method, which will then enable you to retrieve the authorization code.
+
+    ```ruby
+    client = WeiboOAuth2::Client.new  
+    ```
+
+    Or you can pass the key and secret to new a client if you did not set WeiboOAuth2::Config
+
+    Redirect to this URL. If user grants you permission, then you will get the authorization code.
+
+    ```ruby
+    client.authorize_url
+    ```
+
+    In your callback handling method, you should add something like the following,
+
+    ```ruby
+    client.auth_code.get_token(params[:code])
+    ```
+
+    which will give permission to your client.
+
+2.  How to post a status with picture? (or call other interfaces)
+
+    Simply update a status
+
+    ```ruby
+    client.statuses.update(params[:status])
+    ```
+
+    Upload a picture.
+
+    ```ruby
+    pic = params[:file].delete(:tempfile)
+    client.statuses.upload(params[:status], pic, params[:file])
+    ```
+
+    pass params[:file] into upload method as options could help weibo_2 to build post body, useful options as:
+    *   filename, filename with extension of the uploading file, example 'pic.jpg'
+    *   type, mime type of the uploading file, example 'image/jpeg'
+
+## Setting up SSL certificates
+
+This gem using [faraday](https://github.com/technoweenie/faraday) for connection, which supports ssl. According to [this article](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates), you can do as following to support ssl connection.
+
+### Ubuntu
+
+To locate your SSL certificate folder, type `openssl version -a`. Append `/certs` to the OPENSSLDIR listed, here it would be `/usr/lib/ssl/certs`.
+
+```ruby
+    client = WeiboOAuth2::Client.new(YOUR_KEY, YOUR_SECRET, :ssl => {:ca_path => "/usr/lib/ssl/certs"})
+    # or as below if you have set WeiboOAuth2::Config.api_key and WeiboOAuth2::Config.api_secret already
+    # client = WeiboOAuth2::Client.new('', '', :ssl => {:ca_path => "/usr/lib/ssl/certs"})
+```
+
+### On Heroku, Fedora, CentOS
+
+```ruby
+    client = WeiboOAuth2::Client.new(YOUR_KEY, YOUR_SECRET, :ssl => {:ca_file => '/usr/lib/ssl/certs/ca-certificates.crt'})
+    # or as below if you have set WeiboOAuth2::Config.api_key and WeiboOAuth2::Config.api_secret already
+    # client = WeiboOAuth2::Client.new('', '', :ssl => {:ca_file => '/usr/lib/ssl/certs/ca-certificates.crt'})
+```
+
+For Fedora and CentOS, use the path and file `/etc/pki/tls/certs/ca-bundle.crt` instead, or find your system path with `openssl version -a`.
+
+## Integrate with Devise and omniauth
+
+1. Install gems in Gemfile
+
+   ```ruby
+   	 gem 'devise'
+   	 gem 'omniauth'
+	 gem 'omniauth-weibo-oauth2'
+	 gem 'weibo_2'
+   ```
+
+
+2. In devise initailize file config/initiallizers/devise.rb, add a line into setup block, please replace key and secret with yours.
+
+   ```ruby
+     config.omniauth :weibo, 'key', 'secret', :scope => 'user,public_repo'
+   ```
+
+3. Then you should handle omini callback controller by yourself, there is sample project show how to integrate devise and omniauth you can follow [devise-omniauth-example](https://github.com/holden/devise-omniauth-example)
+
+4. After get the callback data, you will see `env['omniauth.auth']['credentials']` has the value `token` and `expires_at`, store them into session or record,now you can use WeiboOAuth2 in anywhere:
+
+   ```ruby
+     client = WeiboOAuth2::Client.new
+     client.get_token_from_hash({:access_token=>session[:token],:expires_at=>session[:expires_at]})
+     statuses = client.statuses
+     statuses.update('just test from my app')
+   ```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/weibo_2/access_token.rb

@@ -0,0 +1,20 @@
+module WeiboOAuth2
+  class AccessToken < OAuth2::AccessToken
+    
+    def validated?
+      !!expires_at && !expired?
+    end
+
+    def expired?
+      expires? && (expires_at < time_convertion(Time.now, '+08:00').to_i)
+    end
+    
+
+    #Convert Time from a time zone to another time zone
+    #'+08:00' or '-08:00'
+    #return Time
+    def time_convertion(time, time_zone)
+      time.getutc.getlocal(time_zone)
+    end  
+  end
+end

data/lib/weibo_2/api/v2/account.rb

@@ -0,0 +1,31 @@
+module WeiboOAuth2
+  module Api
+    module V2
+      class Account < Base
+      
+        #read interfaces
+        def get_privacy(opt={})
+          hashie get("account/get_privacy.json", :params => opt)
+        end
+        
+        def profile_school_list(opt={})
+          hashie get("account/profile/school_list.json", :params => opt)
+        end
+        
+        def rate_limit_status(opt={})
+          hashie get("account/rate_limit_status.json", :params => opt)
+        end
+        
+        def get_uid(opt={})
+          hashie get("account/get_uid.json", :params => opt)
+        end
+        
+        #write interfaces
+        def end_session(opt={})
+          hashie get("account/end_session.json", :params => opt)
+        end
+        
+      end
+    end
+  end
+end

data/lib/weibo_2/api/v2/base.rb

@@ -0,0 +1,79 @@
+require 'hashie'
+require 'json'
+require 'net/http/post/multipart'
+
+module WeiboOAuth2
+  module Api
+    module V2
+      class Base
+        extend Forwardable
+        
+        def_delegators :@access_token, :get, :post, :put, :delete
+        
+        @@API_VERSION = 2
+        
+        def initialize(access_token)
+          @access_token = access_token
+        end
+        
+        def hashie(response)
+          json_body = MultiJson.decode(response.body)
+          if json_body.is_a? Array
+            Array.new(json_body.count){|i| Hashie::Mash.new(json_body[i])}
+          else
+            Hashie::Mash.new json_body
+          end
+        end
+        
+        protected
+        def mime_type(file)
+          case
+            when file =~ /\.jpeg$/i then 'image/jpeg'
+            when file =~ /\.jpg$/i then 'image/jpeg'
+            when file =~ /\.gif$/i then 'image/gif'
+            when file =~ /\.png$/i then 'image/png'
+            when file =~ /\.tiff$/i then 'image/tiff'
+            else 'image/jpeg'
+          end
+        end
+
+        def bin_encode(chunk)
+          chunk.force_encoding(Encoding::BINARY) if chunk.respond_to? :force_encoding
+        end
+        
+        CRLF = "\r\n"
+        def build_multipart_bodies(parts, opts)
+          boundary = Time.now.to_i.to_s(16)
+
+          body = bin_encode('')
+
+          parts.each do |key, value|
+            esc_key = CGI.escape(key.to_s)
+            body << bin_encode("--#{boundary}#{CRLF}")
+            if value.respond_to?(:read)
+              filename = opts.delete(:filename) || File.basename(value.path)
+              mime_type = opts.delete(:type) || mime_type(value.path)
+
+              body << bin_encode("Content-Disposition: form-data; name=\"#{esc_key}\"; filename=\"#{filename}\"#{CRLF}")
+              body << bin_encode("Content-Type: #{mime_type}#{CRLF}")
+              body << bin_encode("Content-Transfer-Encoding: binary#{CRLF*2}")
+              body << bin_encode(value.read)
+            else
+              body << bin_encode("Content-Disposition: form-data; name=\"#{esc_key}\"#{CRLF*2}#{value}")
+            end
+            body << bin_encode(CRLF)
+
+          end 
+
+          body << bin_encode("--#{boundary}--#{CRLF*2}")
+
+          {
+            :body => body,
+            :headers => {"Content-Type" => "multipart/form-data; boundary=#{boundary}"}
+          }
+        end
+        
+      end
+    end
+  end
+end

data/lib/weibo_2/api/v2/comments.rb

@@ -0,0 +1,51 @@
+module WeiboOAuth2
+  module Api
+    module V2
+      class Comments < Base
+      
+        #read interfaces
+        def show(id, opt={})
+          hashie get("comments/show.json", :params => {:id => id}.merge(opt))
+        end
+        
+        def by_me(opt={})
+          hashie get("comments/by_me.json", :params => opt)
+        end
+        
+        def to_me(opt={})
+          hashie get("comments/to_me.json", :params => opt)
+        end
+        
+        def timeline(opt={})
+          hashie get("comments/timeline.json", :params => opt)
+        end
+        
+        def mentions(opt={})
+          hashie get("comments/mentions.json", :params => opt)
+        end
+        
+        def show_batch(cids, opt={})
+          hashie get("comments/show_batch.json", :params => {:cids => cids}.merge(opt))
+        end
+        
+        #write interfaces
+        def create(comment, id, opt={})
+          hashie post("comments/create.json", :params => {:comment => comment, :id => id}.merge(opt))
+        end
+        
+        def destroy(cid, opt={})
+          hashie post("comments/destroy.json", :params => {:cid => cid}.merge(opt))
+        end
+        
+        def destroy_batch(cids, opt={})
+          hashie post("comments/destroy_batch.json", :params => {:cids => cids}.merge(opt))
+        end
+        
+        def reply(cid, id, comment, opt={})
+          hashie post("comments/reply.json", :params => {:cid => cid, :id => id, :comment => comment}.merge(opt))
+        end
+               
+      end
+    end
+  end
+end

data/lib/weibo_2/api/v2/common.rb

@@ -0,0 +1,28 @@
+module WeiboOAuth2
+  module Api
+    module V2
+      class Common < Base
+        #read interfaces
+        def code_to_location(codes, opt={})
+          hashie get("common/code_to_location", :params => {:codes => codes}.merge(opt))
+        end
+        
+        def get_city(province, opt={})
+          hashie get("common/send", :params => {:province => province}.merge(opt))
+        end
+        
+        def get_province(country, opt={})
+          hashie get("common/send", :params => {:country => country}.merge(opt))
+        end
+        
+        def get_country(opt={})
+          hashie get("common/send", :params => {:uids => uids, :tpl_id => tpl_id}.merge(opt))
+        end
+        
+        def get_timezone(opt={})
+          hashie get("common/send", :params => {:uids => uids, :tpl_id => tpl_id}.merge(opt))
+        end
+      end
+    end
+  end
+end

data/lib/weibo_2/api/v2/favorites.rb

@@ -0,0 +1,59 @@
+module WeiboOAuth2
+  module Api
+    module V2
+      class Favorites < Base
+      
+        #read interfaces
+        def favorites(opt={})
+          hashie get("favorites.json", :params => opt)
+        end
+        
+        def ids(opt={})
+          hashie get("favorites/ids.json", :params => opt)
+        end
+        
+        def show(id, opt={})
+          hashie get("favorites/show.json", :params => {:id => id}.merge(opt))
+        end
+        
+        def by_tags(tid, opt={})
+          hashie get("favorites/by_tags.json", :params => {:tid => tid}.merge(opt))
+        end
+        
+        def tags(opt={})
+          hashie get("favorites/tags.json", :params => opt)
+        end
+        
+        def by_tags_ids(tid, opt={})
+          hashie get("favorites/by_tags/ids.json", :params => {:tid => tid}.merge(opt))
+        end
+        
+        #write interfaces
+        def create(id, opt={})
+          hashie post("favorites/create.json", :params => {:id => id}.merge(opt))
+        end
+        
+        def destroy(id, opt={})
+          hashie post("favorites/destroy.json", :params => {:id => id}.merge(opt))
+        end
+        
+        def destroy_batch(ids, opt={})
+          hashie post("favorites/destroy_batch.json", :params => {:ids => ids}.merge(opt))
+        end
+        
+        def tags_update(id, tags, opt={})
+          hashie post("favorites/tags/update.json", :params => {:id => id, :tags => CGI::escape(tags)}.merge(opt))
+        end
+        
+        def tags_update_batch(tid, tag, opt={})
+          hashie post("favorites/tags/update_batch.json", :params => {:tid => tid, :tag => CGI::escape(tag)}.merge(opt))
+        end
+        
+        def tags_destroy_batch(tid, opt={})
+          hashie post("favorites/tags/destroy_batch.json", :params => {:tid => tid}.merge(opt))
+        end
+        
+      end
+    end
+  end
+end

data/lib/weibo_2/api/v2/friendships.rb

@@ -0,0 +1,64 @@
+module WeiboOAuth2
+  module Api
+    module V2
+      class Friendships < Base
+              
+        #read interfaces
+        def friends(opt={})
+          hashie get("friendships/friends.json", :params => opt)
+        end
+        
+        def friends_in_common(uid, opt={})
+          hashie get("friendships/friends/in_common.json", :params => {:uid => uid}.merge(opt))
+        end
+        
+        def friends_bilateral(uid, opt={})
+          hashie get("friendships/friends/bilateral.json", :params => {:uid => uid}.merge(opt))
+        end
+        
+        def friends_bilateral_ids(uid, opt={})
+          hashie get("friendships/friends/bilateral/ids.json", :params => {:uid => uid}.merge(opt))
+        end
+        
+        def friends_ids(opt={})
+          hashie get("friendships/friends/ids.json", :params => opt)
+        end
+        
+        def followers(opt={})
+          hashie get("friendships/followers.json", :params => opt)
+        end
+        
+        def followers_ids(opt={})
+          hashie get("friendships/followers/ids.json", :params => opt)
+        end
+        
+        def followers_active(uid, opt={})
+          hashie get("friendships/followers/active.json", :params => {:uid => uid}.merge(opt))
+        end
+        
+        def friends_chain_followers(uid, opt={})
+          hashie get("friendships/friends_chain/followers.json", :params => {:uid => uid}.merge(opt))
+        end
+        
+        def show(opt={})
+          hashie get("friendships/show.json", :params => opt)
+        end
+        
+        
+        #write interfaces
+        def create(opt={})
+          hashie post("friendships/create.json", :params => opt)
+        end
+        
+        def destroy(opt={})
+          hashie post("friendships/destroy.json", :params => opt)
+        end
+        
+        def remark_update(uid, remark, opt={})
+          hashie post("friendships/remark/update.json", :params => {:uid => uid, :remark => remark}.merge(opt))
+        end
+        
+      end
+    end
+  end
+end

data/lib/weibo_2/api/v2/location.rb

@@ -0,0 +1,83 @@
+module WeiboOAuth2
+  module Api
+    module V2
+      class Location < Base
+        
+        #read interfaces
+        def base_get_map_image(opt={})
+          hashie get("location/base/get_map_image.json", :params => opt)
+        end
+        
+        def geo_ip_to_geo(ip, opt={})
+          hashie get("location/geo/ip_to_geo.json", :params => {:ip => ip}.merge(opt))
+        end
+        
+        def geo_address_to_geo(address, opt={})
+          hashie get("location/geo/address_to_geo.json", :params => {:address => address}.merge(opt))
+        end
+        
+        def geo_geo_to_address(coordinate, opt={})
+          hashie get("location/geo/geo_to_address.json", :params => {:coordinate => coordinate}.merge(opt))
+        end
+        
+        def geo_gps_to_offset(coordinate, opt={})
+          hashie get("location/geo/gps_to_offset.json", :params => {:coordinate => coordinate}.merge(opt))
+        end
+        
+        def geo_is_domestic(coordinates, opt={})
+          hashie get("location/geo/is_domestic.json", :params => {:coordinate => coordinate}.merge(opt))
+        end
+        
+        def pois_show_batch(srcids, opt={})
+          hashie get("location/pois/show_batch.json", :params => {:srcids => srcids}.merge(opt))
+        end
+        
+        def pois_search_by_location(opt={})
+          hashie get("location/pois/search/by_location.json", :params => opt)
+        end
+        
+        def pois_search_by_geo(opt={})
+          hashie get("location/pois/search/by_geo.json", :params => opt)
+        end
+        
+        def pois_search_by_area(coordinates, opt={})
+          hashie get("location/pois/search/by_area.json", :params => {:coordinate => coordinate}.merge(opt))
+        end
+        
+        #to implement
+        def mobile_get_location(opt={})
+          #hashie get("location/mobile/get_location.json", :params => opt)
+          nil
+        end
+        
+        def line_drive_route(opt={})
+          hashie get("location/line/drive_route.json", :params => opt)
+        end
+        
+        def line_bus_route(opt={})
+          hashie get("location/line/bus_route.json", :params => opt)
+        end
+        
+        def line_bus_line(q, opt={})
+          hashie get("location/line/bus_line.json", :params => {:q => q}.merge(opt))
+        end
+        
+        def line_bus_station(q, opt={})
+          hashie get("location/line/bus_station.json", :params => {:q => q}.merge(opt))
+        end
+        
+        #write interfaces
+        def pois_add(srcid, name, address, city_name, category, longitude, latitude, opt={})
+          hashie post("location/pois/add.json", :params => {:srcid => srcid,
+                                                            :name => name,
+                                                            :address => address,
+                                                            :city_name => city_name,
+                                                            :category => category,
+                                                            :longitude => longitude,
+                                                            :latitude => latitude}.merge(opt))
+        end
+        
+      end
+    end
+  end
+end

data/lib/weibo_2/api/v2/notification.rb

@@ -0,0 +1,12 @@
+module WeiboOAuth2
+  module Api
+    module V2
+      class Notification < Base
+        #read interfaces
+        def send(uids, tpl_id, opt={})
+          hashie get("notification/send", :params => {:uids => uids, :tpl_id => tpl_id}.merge(opt))
+        end
+      end
+    end
+  end
+end