rubychina_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b516e37f225835cd24445cf2df8a8751913612f
+  data.tar.gz: 092c9c5472e9954a517a0f8ce61c6305a6ac15c0
+SHA512:
+  metadata.gz: 4954b924170d408e24339c821a159bb615fdba1d69b96845ce6a46ba3257ddb20d419b6fe0153d4aa6a730ce0aa5ff1eb270a1f7d2f904a7fb7df74ae1047a93
+  data.tar.gz: 398be36900cdae9eae5fe3797fadba609d787fc91173b4c55ec0f42b2a702948ad9bcb31c868f4261bef3134cec5f6b0e3a965e5797ffcedcf2e097243c7bad4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 adamshen
+
+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,56 @@
+# RubychinaApi
+
+为了了解如何用Ruby写Web api wrapper做的实验
+
+## Installation
+
+```ruby
+gem 'rubychina_api'
+```
+
+## Usage
+
+#### Api手册
+
+[https://ruby-china.org/api/](https://ruby-china.org/api/)
+
+#### 登录
+```ruby
+RubychinaApi::Config.client_id = "blabla"
+RubychinaApi::Config.secret = "blabla"
+
+RubychinaApi::Client.login("username" => "name", "password" => "xxxx")
+=> #<RubychinaApi::Client:0x007fda3cdf98f0
+ @avatar_url=
+  "https://ruby-china-files.b0.upaiyun.com/user/large_avatar/xxxxx.jpg",
+ @id=xxxxx,
+ @meta=nil,
+ @name="xxxx">
+```
+
+#### Api请求
+使用get、post方法请求数据
+```ruby
+response = RubychinaApi::Operation.get("topics")
+JSON.parse(response.body)["topics"].last.fetch("title")
+=> "Rails－ 让我欢喜让我忧！"
+```
+
+需要二级url时，增加参数
+```ruby
+response = RubychinaApi::Operation.get("topics", "24325")
+JSON.parse(response.body).dig("topic","title")
+=> "《提问的智慧》"
+```
+
+需要params时，增加hash作为尾参数
+```ruby
+response = RubychinaApi::Operation.get("topics", {"type": "no_reply"})
+JSON.parse(response.body)["topics"].first.fetch("id")
+=> "给指定 url POST 包的时候，用 YAML.load_file 方法：当 YML 文件内有汉字时，报 utf-8 错"
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/rubychina_api.rb

@@ -0,0 +1,15 @@
+require "oauth2"
+require "json"
+require "faraday"
+
+require_relative "rubychina_api/version"
+require_relative "rubychina_api/client"
+require_relative "rubychina_api/operation"
+
+module RubychinaApi
+  class Config
+    class << self
+      attr_accessor :client_id, :secret, :access_token
+    end
+  end
+end

data/lib/rubychina_api/client.rb

@@ -0,0 +1,19 @@
+module RubychinaApi
+  class Client
+    attr_reader :id, :name, :avatar_url, :meta
+
+    def initialize(attributes)
+      @id = attributes["id"]
+      @name = attributes["name"]
+      @avatar_url = attributes["avatar_url"]
+      @meta = attributes["meta"]
+    end
+
+    def self.login(option)
+      client = OAuth2::Client.new(RubychinaApi::Config.client_id, RubychinaApi::Config.secret, site: 'https://ruby-china.org')
+      RubychinaApi::Config.access_token = client.password.get_token(option["username"], option["password"]).token
+      response = RubychinaApi::Operation.get("hello")
+      new(JSON.parse(response.body).fetch("user"))
+    end
+  end
+end

data/lib/rubychina_api/operation.rb

@@ -0,0 +1,25 @@
+module RubychinaApi
+  class Operation
+    API_URL = "https://ruby-china.org/api/v3/"
+
+    class << self
+      def method_missing(method_id, *args)
+        method_name = method_id.id2name
+        raise "invalid operation method" unless valid_method?(method_name)
+        raise "must get access_token first" unless RubychinaApi::Config.access_token
+
+        option = {}
+        option.merge!(args.pop) if args.last.is_a?(Hash)
+
+        Faraday.send method_name,
+                     "#{API_URL}#{args.join('/')}.json?access_token=#{RubychinaApi::Config.access_token}", option
+
+      end
+
+      private
+      def valid_method?(method_name)
+        %w(get post).include?(method_name)
+      end
+    end
+  end
+end

data/lib/rubychina_api/version.rb

@@ -0,0 +1,3 @@
+module RubychinaApi
+  VERSION = "0.1.0"
+end

data/rubychina_api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubychina_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "rubychina_api"
+  spec.version = RubychinaApi::VERSION
+  spec.authors = ["adamshen"]
+  spec.email = ["adam_ruby@126.com"]
+  spec.summary = %q{Simple wrapper for the RubyChina API}
+  spec.description = %q{Simple wrapper for the RubyChina API}
+  spec.homepage = "https://github.com/adamshen/rubychina_api"
+  spec.license = "MIT"
+  spec.files = %w(LICENSE.txt README.md Rakefile rubychina_api.gemspec)
+  spec.files += Dir["lib/**/*"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+  spec.add_dependency "oauth2"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: rubychina_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- adamshen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple wrapper for the RubyChina API
+email:
+- adam_ruby@126.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rubychina_api.rb
+- lib/rubychina_api/client.rb
+- lib/rubychina_api/operation.rb
+- lib/rubychina_api/version.rb
+- rubychina_api.gemspec
+homepage: https://github.com/adamshen/rubychina_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple wrapper for the RubyChina API
+test_files: []