gc-restful-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e57a6fc96b3ae1f71f3be3f8e82b43861e73b82f
+  data.tar.gz: 56c5b4d61a62bf650cfb38dccc66958098707f1d
+SHA512:
+  metadata.gz: ce538681d63503fe9c225d696eb670809eebfd2736da8a6d2d37305422260baad5babe436ba783c7cb734321f1331007362ecc72e2bdf22802ee750c06984a20
+  data.tar.gz: f2e68419eece3f8b8b17780536cf06a4104e45fa014b56bcd283ad9fefc78cef242db9b8db9a125519c3c85e98596bcf623b06d48673c6bb3dae209f442f871d

data/.gitignore

@@ -0,0 +1,5 @@
+*.lock
+*.gem
+cookies
+storage
+pkg

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ran
+
+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,40 @@
+# Gc::Restful::Api
+
+A Rack middleware of RESTful API for Git-Contacts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gc-restful-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gc-restful-api
+
+## Usage
+
+```ruby
+  require "erb"
+  require 'sinatra'
+  require "sinatra/config_file"
+  require "gc-restful-api"
+
+  register Sinatra::ConfigFile
+
+  # load configration
+  config_file "config.yml"
+
+  get '/' do
+    content_type 'text/html'
+    erb :index
+  end
+
+  use App
+```

data/Rakefile

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

data/gc-restful-api.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gc-restful-api"
+  spec.version       = Api::VERSION
+  spec.authors       = ["Ran"]
+  spec.email         = ["abbshr@outlook.com"]
+  spec.summary       = %q{Git-Contacts Restful API}
+  spec.description   = %q{Git-Contacts Restful API}
+  spec.homepage      = ""
+  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_runtime_dependency "gitcontacts", "~> 0.1.4"
+  spec.add_runtime_dependency "sinatra", "~> 1.4.5"
+  spec.add_runtime_dependency "thin", "~> 1.6.3"
+  spec.add_runtime_dependency "sinatra-contrib", "~> 1.4.2"
+  spec.add_runtime_dependency "moneta", "~> 0.8.0"
+  
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/api/routes/card.rb

@@ -0,0 +1,115 @@
+class App
+  # code review: @abbshr
+  # 获取cards
+  # => /contacts/id/cards?keyword=ninja_2000
+  get '/contacts/:contacts_id/cards' do
+    if uid = session[:uid]
+      @return_message[:cards] = GitContacts::get_contacts_cards_by_related(uid, params[:contacts_id], params[:keyword] || '')
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  # code review: @abbshr
+  get '/contacts/:contacts_id/card/:card_id' do
+    if uid = session[:uid]
+      @return_message[:card] = GitContacts::get_contacts_card(uid, params[:contacts_id], params[:card_id])
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      when :non_exist
+        @return_message[:errmsg] = 'Card Not Found'
+        status 404
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  # code review: @abbshr
+  post '/contacts/:contacts_id/card' do
+    if uid = session[:uid]
+      ret = GitContacts::add_contacts_card(uid, params[:contacts_id], @body[:payload])
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+        @return_message[:card_id] = ret
+      when :pend
+        @return_message[:pending] = 1
+        @return_message[:qid] = ret
+        status 202
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+
+    # code review: @abbshr
+  patch '/contacts/:contacts_id/card/:card_id' do
+    if uid = session[:uid]
+      ret = GitContacts::edit_contacts_card(uid, params[:contacts_id], params[:card_id], @body[:payload])  
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :pend
+        @return_message[:pending] = 1
+        @return_message[:qid] = ret
+        status 202
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      when :non_exist
+        @return_message[:errmsg] = 'Card Not Found'
+        status 404
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+
+    # code review: @abbshr
+  delete '/contacts/:contacts_id/card/:card_id' do
+    if uid = session[:uid]
+      ret = GitContacts::delete_contacts_card(uid, params[:contacts_id], params[:card_id])
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :pend
+        @return_message[:pending] = 1
+        @return_message[:qid] = ret
+        status 202
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      when :non_exist
+        @return_message[:errmsg] = 'Card Not Found'
+        status 404
+      end
+    else
+      @return_message[:errmsg] = "Token invalid"
+      status 401
+    end
+    @return_message.to_json
+  end
+end

data/lib/api/routes/contacts.rb

@@ -0,0 +1,119 @@
+class App
+  # code review: @abbshr
+  # => /contacts?count=20&filter=gt&name=family
+  get '/contacts' do
+    if uid = session[:uid]
+      params[:name] ||= ''
+      params[:count] = params[:count].to_i || 0
+      @return_message[:contacts] = GitContacts::get_contacts_if uid do |contacts|
+        case params[:filter]
+        when 'eq'
+          cond = contacts[:count] == params[:count]
+        when 'gt'
+          cond = contacts[:count] >= params[:count]
+        when 'lt'
+          cond = contacts[:count] <= params[:count]
+        else
+          cond = true
+        end
+        cond && contacts[:name].include?(params[:name])
+      end
+      @return_message[:success] = 1 if GitContacts::errsym == :ok
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  # code review: @abbshr
+  post '/contacts' do
+    if uid = session[:uid]
+      @return_message[:contacts_id] = GitContacts::add_contacts(uid, @body[:contacts_name])
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :miss_args
+        @return_message[:errmsg] = 'Contacts Name is Required'
+        status 400
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  get '/contacts/:contacts_id' do
+    if uid = session[:uid]
+      @return_message[:contact] = GitContacts::get_contacts_if uid do |contact| 
+        contact[:gid] == params[:contacts_id] 
+      end.first
+      @return_message[:success] = 1 if GitContacts::errsym == :ok
+    else
+      @return_message[:errmsg] = 'Token invalid'
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  # code review: @abbshr
+  patch '/contacts/:contacts_id' do
+    if uid = session[:uid]
+      GitContacts::edit_contacts_meta(uid, params[:contacts_id], @body[:metadata])
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :miss_args
+        @return_message[:errmsg] = 'Metadata is Required'
+        status 400
+      when :forbidden
+        @return_message[:errmsg] = "Access Forbidden"
+        status 403
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  # code review: @abbshr
+  get '/contacts/:contacts_id/history' do
+    if uid = session[:uid]
+      @return_message[:history] = GitContacts::get_contacts_history(uid, params[:contacts_id])
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  # code review: @abbshr
+  post '/contacts/:contacts_id/revert' do
+    if uid = session[:uid]
+      @return_message[:oid] = GitContacts::revert_to(uid, params[:contacts_id], @body[:oid])
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      when :non_exist
+        @return_message[:errmsg] = 'Commit Not Found'
+        status 404
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+end

data/lib/api/routes/request.rb

@@ -0,0 +1,51 @@
+class App
+  # code review: @AustinChou
+  get '/contacts/:contacts_id/requests' do
+    if uid = session[:uid]
+      @return_message[:requests] = GitContacts::get_all_requests params[:contacts_id]
+      @return_message[:success] = 1 if GitContacts::errsym == :ok
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  get '/contacts/:contacts_id/request/:request_id' do
+    if uid = session[:uid]
+      @return_message[:request] = GitContacts::get_a_request params[:contacts_id], params[:request_id]
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :non_exist
+        @return_message[:errmsg] = 'Request Not Found'
+        status 404
+      end
+    else
+      @return_message[:errmsg] = "Token invalid"
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  # code review: @AustinChou
+  patch '/contacts/:contacts_id/request/:request_id/status' do
+    if uid = session[:uid]
+      GitContacts::edit_request_status(uid, params[:contacts_id], params[:request_id], @body[:action])
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      when :non_exist
+        @return_message[:errmsg] = 'Request Not Found'
+        status 404
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+end

data/lib/api/routes/user.rb

@@ -0,0 +1,174 @@
+class App
+  # code review: @abbshr
+  post '/login' do
+    unless session[:uid]
+      if GitContacts::password_valid?(@body[:email], @body[:password])
+        # mark email as uid
+        session[:uid] = @body[:email]
+        @return_message[:success] = 1
+      else
+        status 401
+        @return_message[:errmsg] = "Email and password combination incorrect."
+      end
+    else
+      status 403
+      @return_message[:errmsg] = 'has been login'
+    end
+    @return_message.to_json
+  end
+
+  post '/register' do 
+    unless session[:uid]
+      GitContacts::create_user(@body)
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+        session[:uid] = @body[:email]
+      when :miss_args
+        @return_message[:errmsg] = 'Missing Email or Password'
+        status 400
+      when :exist
+        @return_message[:errmsg] = 'Email has been Taken'
+        status 409
+      end
+    else
+      @return_message[:errmsg] = "has been login"
+      status 403
+    end
+    @return_message.to_json
+  end
+
+  # code review: @abbshr
+  get '/logout' do
+    if session[:uid]
+      @return_message[:success] = 1
+      session.clear
+    else
+      @return_message[:errmsg] = "Not login."
+      status 403
+    end
+    @return_message.to_json
+  end
+
+  get '/users' do
+    if uid = session[:uid]
+      @return_message[:users] = GitContacts::get_users uid
+      @return_message[:success] = 1 if GitContacts::errsym == :ok
+    else
+      @return_message[:errmsg] = "Token invalid"
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  get '/user/:user_id' do
+    if uid = session[:uid]
+      @return_message[:user] = GitContacts::get_a_user uid, params[:user_id]
+      case GitContacts::errsym
+      when :ok 
+        @return_message[:success] = 1
+      when :non_exist 
+        @return_message[:errmsg] = "User Not Found"
+        status 404
+      end
+    else
+      @return_message[:errmsg] = "Token invalid"
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  # code review: @abbshr
+  get '/contacts/:contacts_id/users' do
+    if uid = session[:uid]
+      @return_message[:users] = GitContacts::get_contacts_users uid, params[:contacts_id]
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  post '/contacts/:contacts_id/user' do
+    if uid = session[:uid]
+      GitContacts::add_contacts_user uid, params[:contacts_id], @body[:uid]
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :non_exist
+        @return_message[:errmsg] = 'User Not Found'
+        status 404
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      end
+    else
+      @return_message[:errmsg] = 'Token invalid'
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  get '/contacts/:contacts_id/user/:user_id/privilege' do
+    if uid = session[:uid]
+      @return_message[:privilege] = GitContacts::get_contacts_user_privileges(uid, params[:contacts_id], params[:user_id])
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      end
+    else
+      status 401
+      @return_message[:errmsg] = "Token invaild"
+    end
+    @return_message.to_json
+  end
+
+  # code review: @AustinChou
+  delete '/contacts/:contacts_id/user/:user_id' do
+    if uid = session[:uid]
+      GitContacts::remove_contacts_user(uid, params[:contacts_id], params[:user_id])
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+
+  # code review: @AustinChou
+  patch '/contacts/:contacts_id/user/:user_id/privilege' do
+    if uid = session[:uid]
+      GitContacts::edit_contacts_user_privileges(uid, params[:contacts_id], params[:user_id], @body[:role])
+      case GitContacts::errsym
+      when :ok
+        @return_message[:success] = 1
+      when :bad_args
+        @return_message[:errmsg] = 'Invalid role'
+        status 400
+      when :forbidden
+        @return_message[:errmsg] = 'Access Forbidden'
+        status 403
+      end
+    else
+      @return_message[:errmsg] = "Token invalid."
+      status 401
+    end
+    @return_message.to_json
+  end
+end

data/lib/api/version.rb

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

data/lib/gc-restful-api.rb

@@ -0,0 +1,37 @@
+require 'sinatra'
+require 'sinatra/base'
+require "sinatra/cookies"
+require "sinatra/config_file"
+require "rack/session/moneta"
+require 'json'
+require 'gitcontacts'
+
+class Hash
+  def to_json
+    JSON.generate self
+  end
+end
+
+# session control
+use Rack::Session::Moneta, store: Moneta.new(:Redis, expires: 60 * 60 * 24 * 7)
+
+class App < Sinatra::Base
+  # before each request
+  before do
+    # TODO: a pretty way to get request json
+    begin
+      @body = JSON.parse request.body.read, { symbolize_names: true }
+    rescue => e
+      puts "Error: [ #{e} ]"
+    end
+    content_type 'application/json'
+    status 200
+    @return_message = {}
+  end
+
+  # routes
+  require 'api/routes/contacts'
+  require 'api/routes/card'
+  require 'api/routes/user'
+  require 'api/routes/request'
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: gc-restful-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitcontacts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Git-Contacts Restful API
+email:
+- abbshr@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gc-restful-api.gemspec
+- lib/api/routes/card.rb
+- lib/api/routes/contacts.rb
+- lib/api/routes/request.rb
+- lib/api/routes/user.rb
+- lib/api/version.rb
+- lib/gc-restful-api.rb
+homepage: ''
+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: Git-Contacts Restful API
+test_files: []