workxp 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODg5YTkzY2JmNGI3YmVkNzllZGZlYTlmMWVlNGRlNzA3MTAzMDA2Yg==
+  data.tar.gz: !binary |-
+    OGQ0YTYxZjAwYWIwZmE3ODI5MzYzNTNmMjUxYzcwYmMyMjk4YjEwMQ==
+SHA512:
+  metadata.gz: !binary |-
+    NGM2NWI4Y2QzZTNjODE2OTFhOGZlNzdhM2VlODVlODMzMTRkOWFiODhhNDg3
+    ZTEyMDAzNzA5NGNkZjU2ZDkxMTRmMTg1NTA5Mzc0OWNlNjUyNzhmYjZkNGVl
+    YTMwNmI3OTZkM2ZmMTdhMzNiYjYyMmFkNWFhMDQ2ZDg1YzQxZmY=
+  data.tar.gz: !binary |-
+    YjQwZjgxM2IyNzFiYmViYTEzMGIyMjY2MDYzZWM2YmVlYTA4NmExMTUwNDJm
+    OGIxZTNlNjNhYzUwZGEzMDY2ODljYTM2ZDU4NjE5MjcxNzljYzM0N2FmY2Vm
+    MDAxYjljMTFhZDJkZGFhMTNmN2Y3ODFiMTdlNjcyMmFlNDU2ZTI=

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuan Ping
+
+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,101 @@
+# Workxp
+
+A Ruby interface to the [WorkXP API](https://github.com/yuanping/workxp-api).
+
+在OAuth2::Client的基础上封装了WorkXP API，使用OAuth2的Token创建Workxp::Client，返回Hash或Array。  
+获取OAuth2 Token可以使用 [omniauth-workxp](https://github.com/liuqi1024/omniauth-workxp) Gem。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'workxp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install workxp
+
+## Usage
+
+```shell
+client = Workxp::Client.new token: 'oauth2 token', 
+                    refresh_token: 'oauth2 refresh token', 
+                       expires_at: 1.month.from_now, 
+                       sub_domain: 'your subdomain',
+                          app_key: 'app key', 
+                       app_secret: 'app secret',
+                       user_agent: 'WorkXP iOS客户端'
+                            
+```
+
+获得所有联系人，以Hash的方式传参数
+
+    client.contacts #=> [{"id": 37, name: 'YuanPing', ...}]
+    client.contacts "begin" => '2014-06-01T10:00:00+0800', "end" => '2014-07-01T10:00:00+0800', "page" => 2
+    
+通过ID取某一个联系人信息
+
+    client.contact '37'  #=> {"id": 37, name: 'YuanPing', ...}
+
+创建、更新一个联系人
+
+    contact_hash = {name: 'Pan', type: 'Person', contact_methods: [{type: 'ContactPhone', key: 'mobile', value: '13800138000'}]}
+    client.create_contact contact_hash.to_json
+    #=> {"id": 38, name: 'Pan', ...}
+    
+    client.update_contact '38', contact_hash.to_json
+    
+删除联系人    
+
+    client.delete_contact '38'
+    
+## API List
+联系人
+```shell
+contacts(opts={})
+contact(id)
+create_contact(json)
+update_contact(id, json)
+delete_contact(id)
+```
+
+机会
+```shell
+deals(opts={})
+deal(id)
+create_deal(json)
+update_deal(id, json)
+delete_deal(id)
+```
+
+项目(kase) 账户信息(account) 分类(category) 任务(task) 事件(note) 的接口与联系人与机会接口的命名规则相同。  
+
+其它接口：
+```shell
+deletions(opts={})
+
+task_categories(opts={})
+groups
+tags
+
+# create_attachment '/path/file.png', 'image/png'
+create_attachment(file_path, file_type)
+
+# search_activities term: 'test'
+search_activities(opts={})
+
+activities(opts={})
+
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/workxp.rb

@@ -0,0 +1,6 @@
+require "workxp/version"
+require 'workxp/client'
+
+module Workxp
+  # Your code goes here...
+end

data/lib/workxp/client.rb

@@ -0,0 +1,124 @@
+require "workxp/restfulable"
+
+module Workxp
+  class Client
+  
+    delegate :delete, :get, :post, :put, :request, to: :valid_token
+    
+    WORKXP_SITE = "https://workxp.info"
+    
+    include Workxp::Restfulable
+    
+    # OAuth2::AccessToken
+    #
+    # Store authorized infos
+    attr_accessor :access_token
+    
+    # WorkXP product's subdomain. subdomain is your product's identify.
+    # Your can set different subdomain for fetch different product's data.
+    # @example
+    # https://ruby.workxp.info 'ruby' is subdomain
+    attr_accessor :sub_domain
+    
+    # @param [Hash] opts the options to create WorkXP Client.
+    # @option opts [String] :app_key <required>
+    # @option opts [String] :app_secret <required>
+    # @option opts [String] :token oauth2 access token. <required>
+    # @option opts [String] :refresh_token <optional>
+    # @option opts [DateTime] :expires_at <optional>
+    # @option opts [String] :workxp_site <optional>
+    # @option opts [String] :sub_domain <optional>
+    # @option opts [String] :user_agent <optional> App name of client
+    def initialize(opts={})
+      @app_key = opts.delete :app_key
+      @app_secret = opts.delete :app_secret
+      @workxp_site = opts.delete(:workxp_site) || WORKXP_SITE
+      @user_agent = opts.delete(:user_agent)
+      self.sub_domain = opts.delete :sub_domain
+      
+      self.access_token = OAuth2::AccessToken.new(self.oauth_client, opts[:token], opts)
+    end
+
+    # OAuth2::Client instance with WorkxP OAuth
+    def oauth_client
+      @oauth_client ||= OAuth2::Client.new @app_key, @app_secret, site: @workxp_site do |stack|
+                          stack.request :multipart
+                          stack.request :url_encoded
+                          stack.adapter :net_http
+                        end
+    end
+    
+    def valid_token
+      if access_token.expired?
+        self.access_token = access_token.refresh!
+      end
+      self.access_token
+    end
+    
+    # @param [Hash] opts the request parameters
+    # @option opts [String] :group_id Filter by group_id
+    def users(opts={})
+      valid_token.get('/api/users.json', params: opts, headers: domain_hash).parsed
+    end
+    
+    def user(id)
+      valid_token.get("/api/users/#{id}.json", headers: domain_hash).parsed
+    end
+    
+    def accounts
+      valid_token.get("/api/accounts.json", )
+    end
+    
+    def activities(opts={})
+      valid_token.get('/api/activities.json', params: opts, headers: domain_hash).parsed
+    end
+    
+    def search_activities(opts={})
+      valid_token.get('/api/activities/search.json', params: opts, headers: domain_hash).parsed
+    end
+    
+    def activity(id)
+      valid_token.get("/api/activities/#{id}.json", headers: domain_hash).parsed
+    end
+    
+    # @param [String] file_path 'path/avatar.png' 
+    # @param [String] file_type 'image/png'
+    # @return [Hash] {"token"=>"1578a2cd0682359935ae03826fb892701f7c5120"}
+    def create_attachment(file_path, file_type)
+      payload = {file: Faraday::UploadIO.new(file_path, file_type)}
+      valid_token.post("/api/attachments.json", body: payload, headers: {:'Sub-Domain' => sub_domain}).parsed
+    end
+
+    def tags
+      valid_token.get('/api/tags.json', headers: domain_hash).parsed
+    end
+
+    def groups
+      valid_token.get('/api/groups.json', headers: domain_hash).parsed
+    end
+    
+    def deletions(opts={})
+      valid_token.get('/api/deletions.json', params: opts, headers: domain_hash).parsed
+    end
+
+
+    restful_api "account"
+    restful_api "contact"
+    restful_api "task"
+    restful_api "note"
+    restful_api "deal"
+    restful_api "kase"
+    restful_api "category"
+    
+    def task_categories
+      categories.select {|obj| obj['type'] == 'TaskCategory'}
+    end
+    
+    private
+    def domain_hash
+      raise(ArgumentError, "WorkXP Subdomain required.") if sub_domain.nil?
+      {:'Sub-Domain' => sub_domain, :'Content-Type' => 'application/json', :'User-Agent' => (@user_agent || 'WorkXP Client')}
+    end
+
+  end
+end

data/lib/workxp/restfulable.rb

@@ -0,0 +1,34 @@
+module Workxp::Restfulable
+  
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    
+    def restful_api(name)
+      names = name.pluralize
+      define_method "#{names}" do |*args|
+        opts = args.first || Hash.new
+        valid_token.get("/api/#{names}.json", params: opts, headers: domain_hash).parsed
+      end
+  
+      define_method name do |id|
+        valid_token.get("/api/tasks/#{id}.json", headers: domain_hash).parsed
+      end
+  
+      define_method "create_#{name}" do |json|
+        valid_token.post("/api/#{names}.json", body: json, headers: domain_hash).parsed
+      end
+  
+      define_method "update_#{name}" do |id, json|
+        valid_token.put("/api/#{names}/#{id}.json", body: json, headers: domain_hash).parsed
+      end
+  
+      define_method "delete_#{name}" do |id|
+        valid_token.delete("/api/#{names}/#{id}.json", headers: domain_hash).parsed
+      end
+    end
+    
+  end
+end

data/lib/workxp/version.rb

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

data/workxp.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workxp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "workxp"
+  spec.version       = Workxp::VERSION
+  spec.authors       = ["Yuan Ping"]
+  spec.email         = ["yp.xjgz@gmail.com"]
+  spec.description   = %q{A Ruby interface to the WorkXP API.}
+  spec.summary       = %q{A Ruby interface to the WorkXP API.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  
+  spec.add_dependency "oauth2"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: workxp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuan Ping
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !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'
+description: A Ruby interface to the WorkXP API.
+email:
+- yp.xjgz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/workxp.rb
+- lib/workxp/client.rb
+- lib/workxp/restfulable.rb
+- lib/workxp/version.rb
+- workxp.gemspec
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to the WorkXP API.
+test_files: []