diandian-oauth 0.0.2 → 0.0.3

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+#RubyMine stuffs
+.idea

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'oauth2', '~> 0.8.0'
+gem 'activemodel', '~> 3.2.6'
+gem 'activesupport', ' ~> 3.2.1'

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.7)
+      activesupport (= 3.2.7)
+      builder (~> 3.0.0)
+    activesupport (3.2.7)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    faraday (0.8.1)
+      multipart-post (~> 1.1)
+    httpauth (0.1)
+    i18n (0.6.0)
+    jwt (0.1.5)
+      multi_json (>= 1.0)
+    multi_json (1.3.6)
+    multipart-post (1.1.5)
+    oauth2 (0.8.0)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    rack (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (~> 3.2.6)
+  activesupport (~> 3.2.1)
+  oauth2 (~> 0.8.0)

data/README.md

@@ -0,0 +1,4 @@
+diandian-oauth
+==============
+
+diandian-oauth is a Ruby client for diandian API

data/diandian-oauth.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'diandian-oauth'
+  s.version     = '0.0.3'
+  s.date        = '2012-07-24'
+  s.summary     = "Client for diandian API"
+  s.description = "A Ruby Client for diandian API"
+  s.authors     = ["Rainer Du"]
+  s.email       = 'dusiyu@diandian.com'
+  s.files       = ["lib/diandian_oauth.rb"]
+  s.homepage    = 'https://github.com/secretworry/diandian-oauth'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency("oauth2", '~> 0.8.0')
+  s.add_dependency("activemodel", '~> 3.2.6')
+  s.add_dependency("activesupport", '~> 3.2.1')
+end

data/lib/diandian/model/base.rb

@@ -0,0 +1,28 @@
+module Diandian
+	module Model
+		class Base
+			include ActiveModel::AttributeMethods
+			include ActiveModel::Serializers::JSON
+			include ActiveModel::Validations
+
+			def initialize( attributes = {})
+				@attributes = attributes
+			end
+
+			class << self
+				def model_name model_name = nil
+					@model_name = model_name if model_name
+					@model_name ||= self.name.downcase
+				end
+			end
+
+			def model_name
+				self.class.model_name
+			end
+
+			def id
+				nil
+			end
+		end
+	end
+end

data/lib/diandian/model/blog.rb

@@ -0,0 +1,11 @@
+module Diandian
+	module Model
+		class Blog < Diandian::Model::Base
+			define_attribute_methods [:title, :posts, :name, :updated, :description, :likes, :blogCName]
+
+			def id
+				self.blogCName
+			end
+		end
+	end
+end

data/lib/diandian/model/post.rb

@@ -0,0 +1,20 @@
+module Diandain
+	module Model
+		class Post < Diandian::Model::Base
+			# define common attributes
+			define_attribute_methods [:format, :blogName, :blogCName, :postId, :postUrl, :type, :createTime, :tag, :commentCount, :reblogCount, :likeCount]
+			# define reblogInfo related attribute
+			define_attribute_methods [:reblogedFromUrl, :reblogedFromName, :reblogedFromTitle, :reblogedRootUrl, :reblogedRootName, :reblogedRootTitle]
+			# define text specified attributes
+			define_attribute_methods [:title, :body]
+			# define photo specified attributes
+			define_attribute_methods [:caption, :photos]
+			# define audio specified attributes
+			define_attribute_methods [:musicId, :audioType, :cover, :caption, :musicName, :playerUrl, :musicSinger, :coverNormal, :coverLarge, :coverSmall, :albumName, :musicName, :albumId, :artistId]
+			# define video specified attributes
+			define_attribute_methods [:caption, :sourceUrl, :sourceTitle, :videoType, :videoId, :playerUrl, :videoImageUrl]
+			# define link specified attributes
+			define_attribute_methods [:title, :url, :description]
+		end
+	end
+end

data/lib/diandian/model/user.rb

@@ -0,0 +1,7 @@
+module Diandian
+	module Model
+		class User < Diandian::Model::Base
+			define_attribute_methods [:following, :likes, :blogs]
+		end
+	end
+end

data/lib/diandian.rb

@@ -0,0 +1,9 @@
+module Diandian
+	autoload :Model, 'diandian/model'
+	module Model
+		autoload :Base, 'diandian/model/base'
+		autoload :Blog, 'diandian/model/blog'
+		autoload :Post, 'diandian/model/post'
+		autoload :User, 'diandian/model/user'
+	end
+end

data/lib/diandian_oauth/api/interface.rb

@@ -0,0 +1,251 @@
+
+module DiandianOAuth
+  class API
+    module Interface
+      def self.included base
+        base.send :include, InstanceMethods
+        base.extend ClassMethods
+      end
+      module ClassMethods
+        def url_for path, options = {}
+          protocol = options[:protocol] || "https"
+          version = options[:version] || API::VERSION
+          host = options[:host] || API::HOST
+          path = if options[:no_version] then path else "/#{version}#{path}" end
+          "#{protocol}://#{host}#{path}"
+        end
+
+        def interface name, interface_class
+          self.interfaces[name.to_sym] = interface_class.new
+        end
+
+        def interfaces
+          @interfaces ||= {}
+        end
+      end
+
+      module InstanceMethods
+        def interface interface_name
+          self.class.interfaces[interface_name]
+        end
+      end
+      class Param
+        attr_accessor :name, :required
+
+        DEFAULT_OPTIONS = { required: true }
+        def initialize name, options = {}
+          options = DEFAULT_OPTIONS.merge( options)
+          @name = name
+          @required = options[:required]
+        end
+      end #Param
+
+      class Base
+        def request_url params = {}
+          raise 'subclasses must implement this method'
+        end
+
+        # when the access_token is out-of-date, refresh it automatically
+        def apply! access_token, params, &block
+          access_token.refresh! if access_token.expired?
+          self.apply access_token, params, &block
+        end
+
+        def apply access_token, params, &block
+          raise TokenExpiredException if access_token.expired?
+          params ||= {}
+          action = case request_verb
+          when /get/ then :get
+          when /post/ then :post
+          when /put/ then :put
+          when /delete/ then :delete
+          else raise "unrecognized verb '#{request_verb}'"
+          end # case
+          options = {
+            :params => extract_params(params),
+            :raise_errors => false,
+            :parse => :json
+          }
+          request_url = self.request_url(params)
+          if DiandianOAuth.logger.debug?
+            DiandianOAuth.logger.debug("request with action:'#{action}', request_url:'#{request_url}'")
+          end
+          access_token.request( action, request_url, options, &block)
+        end
+        protected
+        def request_verb
+          self.class.verb
+        end
+        def extract_params params
+          params.symbolize_keys!
+          self.class.params.each_pair.reduce({}) do |result, ele|
+            key = ele[0]
+            param = ele[1]
+            param_value = params[key]
+            if param_value && param.required
+              result[key] = param_value
+            elsif param.required
+              raise ParamIsRequiredException.new( "'#{key}' is required")
+            end
+            result
+          end
+        end
+
+        class << self
+          def param name, options = {}
+            params[name.to_sym] = Param.new( name.to_s, options)
+          end
+          def verb verb=nil
+            @verb = verb if verb
+            @verb ||= 'get'
+          end
+          def params
+            @params ||= {}
+          end
+        end # class
+      end # Base
+
+      class UserInfo < Base
+        def request_url params={}
+          API.url_for '/user/info'
+        end
+      end #UserInfo
+
+      class UserLikes < Base
+        param :limit, :required => false
+        param :offset, :required => false
+        def request_url params={}
+          API.url_for '/user/likes'
+        end
+      end #UserLikes
+
+      class UserFollowings < Base
+        param :limit, :required => false
+        param :offset, :required => false
+        def request_url params={}
+          API.url_for '/user/following'
+        end
+      end #UserFollowing
+
+      class MyTags < Base
+        def request_url params={}
+          API.url_for '/tag/mytags'
+        end
+      end #TagMyTags
+
+      class Blog < Base
+        protected
+        def blog_request_url params
+          blog_cname = params[:blogCName]
+          raise ParamIsRequiredException.new("blogCName is required for interface #{self.class.name}") unless blog_cname
+          API.url_for "/blog/#{blog_cname}"
+        end
+      end #BlogInterface
+
+      class BlogInfo < Base
+        def request_url params={}
+          "#{blog_request_url}/info"
+        end
+      end #BlogInfo
+
+      class BlogAvatar < Base
+        VALID_SIZES = %w{57 72 114 144}
+        def request_url params={}
+          path = [self.blog_request_url(params), 'avatar'].join('/')
+          size = params[:size]
+          if size
+            unless BlogAvatar.is_valid_size size
+              raise IllegalParamException.new("'#{size}' is illegal")
+            end
+          end # if
+        end
+
+        def self.is_valid_size size
+          VALID_SIZES.include? size.to_s
+        end
+
+      end #BlogAvatar
+
+      class BlogFollowers < Base
+        param :limit, :required => false
+        param :offset, :required => false
+        def request_url params={}
+          blog_cname = params[:blogCName]
+          raise ParamIsRequiredException.new("blogCName is required for interface #{self.class.name}") unless blog_cname
+          API.url_for "/blog/#{blog_cname}/info"
+        end
+      end #BlogFollowers
+
+      class Posts < Base
+        param :tag, :required => false
+        param :limit, :required => false
+        param :offset, :required => false
+        param :id, :required => false
+        param :reblogInfo, :required => false
+        param :notesInfo, :required => false
+        param :filter, :required => false
+        def request_url params={}
+          blog_cname = params[:blogCName]
+          raise ParamIsRequiredException.new("blogCName is required for interface #{self.class.name}") unless blog_cname
+          path = "/blog/#{blog_cname}/posts"
+          if params[:type]
+            path = path + "/#{type}"
+          end
+          API.url_for path
+        end
+      end # Posts
+
+      class HomeFeeds < Base
+        param :limit, :required => false
+        param :offset, :required => false
+        param :type, :required => false
+        param :sinceId, :required => false
+        param :reblogInfo, :required => false
+        param :notesInfo, :required => false
+        param :filter, :required => false
+        def request_url params={}
+          API.url_fo "/user/home"
+        end
+      end # Home
+
+      class TagFeeds < Base
+        param :limit, :required => false
+        param :tag, :required => false
+        param :sinceId, :required => false
+        param :reblogInfo, :required => false
+        param :notesInfo, :required => false
+        param :filter, :required => false
+
+        def request_url params={}
+          tag = params[:tag]
+          raise ParamIsRequiredException("tag is required for interface #{self.class.name}") unless tag
+          API.url_for "/tag/posts/#{tag}"
+        end
+      end #TagFeeds
+
+      class Follow < Base
+        verb :post
+        param :blogCName, :required => true
+        def request_url params={}
+          API.url_for "/user/follow"
+        end
+      end # Follow
+
+      class Unfollow < Base
+        verb :post
+        param :blogCName, :required => true
+        def request_url params={}
+          API.url_for '/user/unfollow'
+        end
+      end # Unfollow
+
+      class Submissions < Base
+        def request_url params={}
+          blog_cname = params[:blogCName]
+          raise ParamIsRequiredException("blogCName is required for interface #{self.class.name}") unless blog_cname
+          API.url_for "/blog/#{blog_cname}/submission"
+        end
+      end
+    end # Interface
+  end
+end

data/lib/diandian_oauth/api.rb

@@ -0,0 +1,32 @@
+require 'diandian_oauth/api/interface'
+module DiandianOAuth
+  class API
+	  HOST='api.diandian.com'
+		VERSION='v1'
+
+
+    def authorize_url
+      'https://api.diandian.com/oauth/authorize'
+    end
+
+    def token_url
+      'https://api.diandian.com/oauth/token'
+    end
+
+		include Interface
+		interface :user_info, Interface::UserInfo
+    interface :user_likes, Interface::UserLikes
+    interface :user_followings, Interface::UserFollowings
+    interface :my_tags, Interface::MyTags
+    interface :blog, Interface::Blog
+    interface :blog_info, Interface::BlogInfo
+    interface :blog_avatar, Interface::BlogAvatar
+    interface :blog_followers, Interface::BlogFollowers
+    interface :posts, Interface::Posts
+    interface :home_feeds, Interface::HomeFeeds
+    interface :tag_feeds, Interface::TagFeeds
+    interface :follow, Interface::Follow
+    interface :unfollow, Interface::Unfollow
+    interface :submissions, Interface::Submissions
+	end
+end

data/lib/diandian_oauth/client.rb

@@ -0,0 +1,73 @@
+require 'oauth2'
+module DiandianOAuth
+	class Client
+		attr_accessor :api
+		def initialize client_id, client_secret, options={}
+      @api = options[:api] || DiandianOAuth::API.new
+      @redirect_uri = options[:redirect_uri]
+      @client = OAuth2::Client.new client_id, client_secret, {
+          :authorize_url => @api.authorize_url,
+          :token_url => @api.token_url
+        }
+		end
+
+		def authorize_url response_type='code', scope=[]
+      if response_type.is_a? Array
+        scope = response_type
+        response_type = 'code'
+      end
+      @client.authorize_url(
+          :client_id => @client.id,
+          :response_type => response_type,
+          :scope => scope.join(',')
+      )
+    end
+    def access_token= hash
+      @access_token = case hash
+        when Hash then OAuth2::AccessToken.from_hash(@client, hash)
+        when OAuth2::AccessToken then hash
+        else
+          raise 'illegal argument hash'
+      end
+    end
+		def access_token code_or_hash=nil
+      return @access_token if @access_token
+			return nil unless code_or_hash
+      if code_or_hash.is_a? Hash
+        @access_token = OAuth2::AccessToken.from_hash(@client, code_or_hash)
+      else
+        begin
+          DiandianOAuth.logger.warn('redirect_url is required for authorization_code grant type') unless @redirect_uri
+          @access_token = @client.get_token(
+              :client_id => @client.id,
+              :client_secret => @client.secret,
+              :grant_type => 'authorization_code',
+              :code => code_or_hash,
+              :redirect_uri => @redirect_uri
+          )
+        rescue OAuth2::Error => e
+          DiandianOAuth.logger.error e.to_s
+          raise e
+        end
+      end
+      @access_token
+    end
+
+		def method_missing(meth, *args, &block)
+      force = meth.to_s =~ /!$/
+      meth = $` if force
+			interface = @api.interface meth.to_sym
+			if interface
+        access_token = self.access_token
+        raise 'access_token is required' unless access_token
+        if force
+          interface.apply! access_token, args[0], &block
+        else
+				  interface.apply access_token, args[0], &block
+        end # force
+			else
+				super
+			end
+		end
+	end
+end

data/lib/diandian_oauth/exceptions.rb

@@ -0,0 +1,19 @@
+module DiandianOAuth
+
+  class OAuthException < ::Exception
+  end
+
+  class TokenExpiredException < OAuthException
+  end
+
+  class RefreshTokenExpireException < OAuthException
+  end
+  # APIException
+  class APIException < OAuthException
+  end
+  class ParamIsRequiredException < APIException
+  end
+  class IllegalParamException < APIException
+  end
+  # End APIException
+end

data/lib/diandian_oauth.rb

@@ -4,7 +4,7 @@ require 'diandian_oauth/exceptions'
 require 'active_support/core_ext'
 require 'logger'
 module DiandianOAuth
-	VERSION = '0.0.2'
+	VERSION = '0.0.3'
   module Logger
     def logger *args
       if args.empty?

data/test/diandian_oauth/api_test.rb

@@ -0,0 +1,21 @@
+require File.join( File.dirname(__FILE__), 'test_helper')
+
+class APITest < ActiveSupport::TestCase
+
+  test 'authorize_url' do
+    api = DiandianOAuth::API.new
+    puts api.authorize_url
+  end
+
+  test 'token_url' do
+    api = DiandianOAuth::API.new
+    puts api.token_url
+  end
+
+  test 'user_info' do
+    api = DiandianOAuth::API.new
+    user_info_interface = api.interface :user_info
+    assert_instance_of(DiandianOAuth::API::Interface::UserInfo, user_info_interface)
+    puts user_info_interface.request_url
+  end
+end

data/test/diandian_oauth/authorize_test.rb

@@ -0,0 +1,24 @@
+require File.join( File.dirname(__FILE__), 'test_helper')
+
+class AuthorizeTest < ActiveSupport::TestCase
+  CLIENT_ID="3zgJwues92"
+  CLIENT_SECRET="1rxLZr5R4sweGUATGig25VBc1ka1xDEpkIqJ"
+
+  test 'authorize_url' do
+    assert_nothing_raised do
+      client = DiandianOAuth::Client.new CLIENT_ID, CLIENT_SECRET
+      puts client.authorize_url %w{read write}
+    end
+  end
+
+  test 'access_token' do
+    code = '7KhUBh'
+    unless code.empty?
+      assert_nothing_raised do
+        client = DiandianOAuth::Client.new CLIENT_ID, CLIENT_SECRET, :redirect_uri => 'http://example.com/callback'
+        access_token = client.access_token code
+      end
+    end
+  end
+
+end

data/test/diandian_oauth/interface_test.rb

@@ -0,0 +1,40 @@
+require File.join( File.dirname(__FILE__), 'test_helper')
+
+class InterfaceTest < ActiveSupport::TestCase
+  CLIENT_ID="3zgJwues92"
+  CLIENT_SECRET="1rxLZr5R4sweGUATGig25VBc1ka1xDEpkIqJ"
+  ACCESS_TOKEN = {
+      :access_token => 'adbab585-ea39-47e0-87ce-da7700fd3d9b',
+      :refresh_token => "79852349-5f2e-4e3b-93b8-845e239e61ff",
+      :token_type => "bearer",
+      :expires_in => 604799,
+      :expires_at => 1344317317,
+      :scope => "write read",
+      :uid => "11449"
+  }
+
+  test 'refresh_token' do
+    client = self.client
+    client.access_token= ACCESS_TOKEN
+    p client.access_token.refresh!
+  end
+
+  test 'user_info' do
+    client = self.client
+    client.access_token= ACCESS_TOKEN
+    begin
+      p client.user_info
+    rescue DiandianOAuth::API::TokenExpiredException => e
+    end
+  end
+
+  test 'posts' do
+    client = self.client
+    client.access_token= ACCESS_TOKEN
+    p client.posts :blogCName => 'secretworry'
+  end
+
+  def client
+    @client ||= DiandianOAuth::Client.new CLIENT_ID, CLIENT_SECRET, :redirect_uri => 'http://example.com/callback'
+  end
+end

data/test/diandian_oauth/logger_test.rb

@@ -0,0 +1,16 @@
+require File.join( File.dirname(__FILE__), 'test_helper')
+
+class LoggerTest < ActiveSupport::TestCase
+  test 'default logger' do
+    assert_nothing_raised do
+      DiandianOAuth.logger.info("test")
+    end
+  end
+
+  test 'change logger' do
+    assert_nothing_raised do
+      DiandianOAuth.logger(STDERR)
+      DiandianOAuth.logger.info("test")
+    end
+  end
+end

data/test/diandian_oauth/test_helper.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+require 'active_support/test_case'
+$:.unshift( File.join(File.dirname(__FILE__), "..", "..", "lib"))
+require 'diandian_oauth'

metadata

@@ -2,7 +2,7 @@
 name: diandian-oauth
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Rainer Du
@@ -11,8 +11,40 @@ bindir: bin
 cert_chain: []
 
 date: 2012-07-24 00:00:00 Z
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth2
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.2.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.2.1
+  type: :runtime
+  version_requirements: *id003
 description: A Ruby Client for diandian API
 email: dusiyu@diandian.com
 executables: []
@@ -22,7 +54,27 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- diandian-oauth.gemspec
+- lib/diandian.rb
+- lib/diandian/model.rb
+- lib/diandian/model/base.rb
+- lib/diandian/model/blog.rb
+- lib/diandian/model/post.rb
+- lib/diandian/model/user.rb
 - lib/diandian_oauth.rb
+- lib/diandian_oauth/api.rb
+- lib/diandian_oauth/api/interface.rb
+- lib/diandian_oauth/client.rb
+- lib/diandian_oauth/exceptions.rb
+- test/diandian_oauth/api_test.rb
+- test/diandian_oauth/authorize_test.rb
+- test/diandian_oauth/interface_test.rb
+- test/diandian_oauth/logger_test.rb
+- test/diandian_oauth/test_helper.rb
 homepage: https://github.com/secretworry/diandian-oauth
 licenses: []
 
@@ -50,5 +102,9 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Client for diandian API
-test_files: []
-
+test_files: 
+- test/diandian_oauth/api_test.rb
+- test/diandian_oauth/authorize_test.rb
+- test/diandian_oauth/interface_test.rb
+- test/diandian_oauth/logger_test.rb
+- test/diandian_oauth/test_helper.rb