restclient_api_base 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50ace3660f3c408e006ee031b8710fb48b6648f5
+  data.tar.gz: ead68b84e3ac78f26eef168e1e5cabf796e676ef
+SHA512:
+  metadata.gz: a8cc9beed56ad8eb1f1a790aae2d9b00b086842aafb38fa82ed8041b5210df6dec119b5ff5c520b99cb95c02765592da4a766e27e9ccc129c7324bf52038026b
+  data.tar.gz: d01de8f14e9f0d9535fefebd7c075e7fb8ce900990084644aed3b10937c2f8dc09ded01b0f9d86e38969c76bb239b3a028176f8c3e6a63c3701c5e88e66af416

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in restclient_api_base.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Spirit
+
+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,48 @@
+# RestclientApiBase
+
+以 REST 方式调用外部 API 的基础类, 默认 Content-Type 为 JSON
+
+## Dependency
+
+[active_support/concern](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/concern.rb)
+
+[rest-client](https://github.com/rest-client/rest-client)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'restclient_api_base'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restclient_api_base
+
+## Usage
+
+```ruby
+require 'restclient_api_base'
+
+module A
+  include RestclientApiBase
+
+  self.base_url = 'http://www.example.com'  # define app base url
+  self.private_params = { key: 'api_key' }  # define app secret key
+end
+
+A.get('/api/xxx', key_1: value_1, key_2: value_2)   # => { response: json_response }
+A.post('/api/xxx', key_1: value_1, key_2: value_2)
+A.patch('/api/xxx', key_1: value_1, key_2: value_2)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/Naixspirit/restclient_api_base/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/restclient_api_base/version.rb

@@ -0,0 +1,3 @@
+module RestclientApiBase
+  VERSION = "0.0.1"
+end

data/lib/restclient_api_base.rb

@@ -0,0 +1,76 @@
+require "restclient_api_base/version"
+require "json"
+require "rest-client"
+require "active_support/concern"
+
+module RestclientApiBase
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    # base_url: the api base url, like: http://api.example.com, default is ''
+    # content_type: dafault is { content_type: :json, accept: :json }
+    # private_params: your api secret, like: { app_id: 'xxxx' }, default is {}
+
+    attr_accessor :base_url, :content_type, :private_params
+
+    def get api_url, params = {}
+      res = RestClient.get(
+        base_url + api_url,
+        params: private_params.merge(params)
+      )
+    end
+
+    def post api_url, query = {}, headers = {}
+      res = RestClient.post(
+        base_url + api_url,
+        JSON.generate(private_params.merge(query)),
+        content_type.merge(headers)
+      )
+    end
+
+    def patch api_url, query = {}
+      res = RestClient.patch(
+        base_url + api_url,
+        JSON.generate(private_params.merge(query)),
+        content_type.merge(headers)
+      )
+    end
+
+    def put api_url, query = {}
+      res = RestClient.put(
+        base_url + api_url,
+        JSON.generate(private_params.merge(query)),
+        content_type.merge(headers)
+      )
+    end
+
+    def delete api_url, params = {}
+      res = RestClient.delete(
+        base_url + api_url,
+        params: private_params.merge(params),
+      )
+    end
+
+    def base_url
+      @base_url ||= ''
+    end
+
+    def content_type
+      @content_type ||= { content_type: :json, accept: :json }
+    end
+
+    def content_type= type
+      @content_type = { content_type: type, accept: type }
+    end
+
+    def private_params
+      @private_params ||= {}
+    end
+
+    def private_params= params
+      raise 'the private params must be a hash' unless params.is_a? Hash
+      @private_params = params
+    end
+  end
+end

data/restclinet_api_base.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restclient_api_base/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "restclient_api_base"
+  spec.version       = RestclientApiBase::VERSION
+  spec.authors       = ["Spirit"]
+  spec.email         = ["neverlandxy.naix@gmail.com"]
+  spec.summary       = %q{Base restclient api center}
+  spec.description   = %q{Base restclient api center}
+  spec.homepage      = "https://github.com/NaixSpirit/restclient_api_base"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", "~> 1.7"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+File.dirname(__FILE__) + '/../lib/restclient_api_base'
+
+if Minitest.const_defined?('Test')
+  # We're on Minitest 5+. Nothing to do here.
+else
+  # Minitest 4 doesn't have Minitest::Test yet.
+  Minitest::Test = MiniTest::Unit::TestCase
+end

data/test/test_restclient_api_base.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestRestclientApiBase < Minitest::Test
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  module Client
+
+  end
+
+  def test_aa
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: restclient_api_base
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Spirit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Base restclient api center
+email:
+- neverlandxy.naix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/restclient_api_base.rb
+- lib/restclient_api_base/version.rb
+- restclinet_api_base.gemspec
+- test/test_helper.rb
+- test/test_restclient_api_base.rb
+homepage: https://github.com/NaixSpirit/restclient_api_base
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Base restclient api center
+test_files:
+- test/test_helper.rb
+- test/test_restclient_api_base.rb
+has_rdoc: