cliskip2 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    cliskip2 (0.0.1)
+      faraday_middleware (~> 0.8.7)
+      json (~> 1.7.3)
+      oauth (~> 0.4)
+      simple_oauth (~> 0.1.8)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    faraday (0.8.0)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.8.7)
+      faraday (>= 0.7.4, < 0.9)
+    json (1.7.3)
+    multipart-post (1.1.5)
+    oauth (0.4.6)
+    rake (0.9.2.2)
+    rake-compiler (0.8.1)
+      rake
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    simple_oauth (0.1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cliskip2!
+  rake
+  rake-compiler
+  rspec (~> 2)

data/README.md

@@ -0,0 +1,33 @@
+cliskip2
+========
+
+A Ruby wrapper for the SKIP2 REST APIs
+
+## Installation
+    gem install cliskip2
+
+## Configration
+    Cliskip2.configure do |config|
+      config.endpoint = 'http://localhost:3000'
+      config.consumer_key = YOUR_CONSUMER_KEY
+      config.consumer_secret = YOUR_CONSUMER_SECRET
+      config.xauth_username = SKIP2_ADMIN_USER_NAME
+      config.xauth_password = SKIP2_ADMIN_USER_PASSWORD
+    end
+
+## Examples
+### get the authorized user
+    client = Cliskip2::Client.new
+    client.current_user
+
+### create new user
+    client = Cliskip2::Client.new
+    client.post_user :user => {:name => 'hoge', :email => 'hoge@hoge.com'}
+
+### get the user by email
+    client = Cliskip2::Client.new
+    client.get_user :email => 'hoge@hoge.com'
+
+### update the user by email
+    client = Cliskip2::Client.new
+    client.put_user :user => {:name => 'foobar', :email => 'hoge@hoge.com'}

data/Rakefile

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

data/cliskip2.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cliskip2/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cliskip2"
+  s.version     = Cliskip2::VERSION
+  s.authors     = ["Naoki Maeda"]
+  s.email       = ["maeda.na@gmail.com"]
+  s.homepage    = "http://wiki.github.com/maedana/cliskip2"
+  s.summary     = %q{A Ruby wrapper for the SKIP2 REST APIs}
+  s.description = %q{A Ruby wrapper for the SKIP2 REST APIs}
+
+  s.rubyforge_project = "cliskip2"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'faraday_middleware', '~> 0.8.7'
+  s.add_dependency 'simple_oauth', '~> 0.1.8'
+  s.add_dependency 'json', '~> 1.7.3'
+  s.add_dependency 'oauth', '~> 0.4'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rake-compiler')
+  s.add_development_dependency('rspec', '~> 2')
+end

data/lib/cliskip2/base.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+module Cliskip2
+  class Base
+    attr_accessor :attrs
+
+    # Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key
+    #
+    # @overload self.lazy_attr_reader(attr)
+    #   @param attr [Symbol]
+    # @overload self.lazy_attr_reader(attrs)
+    #   @param attrs [Array<Symbol>]
+    def self.lazy_attr_reader(*attrs)
+      attrs.each do |attribute|
+        class_eval do
+          define_method attribute do
+            @attrs[attribute.to_s]
+          end
+        end
+      end
+    end
+
+    # Initializes a new Base object
+    #
+    # @param attrs [Hash]
+    # @return [Twitter::Base]
+    def initialize(attrs={})
+      @attrs = attrs.dup
+    end
+  end
+end

data/lib/cliskip2/client.rb

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+require 'cliskip2/connection'
+require 'cliskip2/request'
+require 'cliskip2/user'
+require 'cliskip2/config'
+
+module Cliskip2
+  class Client
+    include Cliskip2::Connection
+    include Cliskip2::Request
+
+    attr_accessor *Config::VALID_OPTIONS_KEYS
+
+    # Initializes a new API object
+    #
+    # @param attrs [Hash]
+    # @return [Cliskip2::Client]
+    def initialize(attrs={})
+      attrs = Cliskip2.options.merge(attrs)
+      Config::VALID_OPTIONS_KEYS.each do |key|
+        instance_variable_set("@#{key}".to_sym, attrs[key])
+      end
+    end
+
+    def current_user
+      user_attr = get("/api/get_current_user")
+      @current_user ||= Cliskip2::User.new(user_attr['user'])
+    end
+
+    # Create new user by params
+    # @return [Cliskip2::User]
+    def post_user params
+      user_attr = post("/admin/tenants/#{current_user.tenant_id}/users.json", params)
+      Cliskip2::User.new(user_attr['user'])
+    end
+
+    # Get the user by params
+    # @return [Cliskip2::User]
+    def get_user params
+      user_attr = get("/admin/tenants/#{current_user.tenant_id}/users/show_by_params.json", params)
+      Cliskip2::User.new(user_attr['user'])
+    end
+
+    # Update the user by params
+    # @return [Cliskip2::User]
+    def put_user params
+      user = get_user :email => params[:user][:email]
+      user_attr = put("/admin/tenants/#{current_user.tenant_id}/users/#{user.id}.json", params)
+      Cliskip2::User.new(user_attr['user'])
+    end
+  end
+end

data/lib/cliskip2/config.rb

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+require "cliskip2/version"
+
+module Cliskip2
+  module Config
+    # The HTTP connection adapter that will be used to connect if none is set
+    DEFAULT_ADAPTER = :net_http
+
+    # The Faraday connection options if none is set
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # The consumer key if none is set
+    DEFAULT_CONSUMER_KEY = nil
+
+    # The consumer secret if none is set
+    DEFAULT_CONSUMER_SECRET = nil
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = nil
+
+    # The xauth username if none is set
+    DEFAULT_XAUTH_USERNAME = nil
+
+    # The xauth password if none is set
+    DEFAULT_XAUTH_PASSWORD = nil
+
+    # The value sent in the 'User-Agent' header if none is set
+    DEFAULT_USER_AGENT = "Cliskip2 Ruby Gem #{Cliskip2::VERSION}"
+
+    # An array of valid keys in the options hash when configuring a {Twitter::Client}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :connection_options,
+      :consumer_key,
+      :consumer_secret,
+      :endpoint,
+      :xauth_username,
+      :xauth_password,
+      :user_agent
+    ]
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+      self
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter            = DEFAULT_ADAPTER
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.consumer_key       = DEFAULT_CONSUMER_KEY
+      self.consumer_secret    = DEFAULT_CONSUMER_SECRET
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.xauth_username     = DEFAULT_XAUTH_USERNAME
+      self.xauth_password     = DEFAULT_XAUTH_PASSWORD
+      self.user_agent         = DEFAULT_USER_AGENT
+      self
+    end
+  end
+end

data/lib/cliskip2/connection.rb

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+require 'faraday'
+require 'faraday_middleware'
+require 'oauth'
+require 'cliskip2/request/oauth'
+
+module Cliskip2
+  module Connection
+    private
+
+    # Returns a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection options = {}
+      connection_options = {
+        :headers => {
+          :accept => 'application/json',
+          :user_agent => user_agent,
+        },
+        :url => endpoint
+      }
+      credentials = {
+        :consumer_key    => consumer.key,
+        :consumer_secret => consumer.secret,
+        :token           => access_token.token,
+        :token_secret    => access_token.secret
+      }
+      @connection ||= Faraday.new(connection_options) do |builder|
+        builder.response :raise_error
+        builder.response :json
+        builder.request :url_encoded
+        builder.use Cliskip2::Request::Cliskip2OAuth, credentials
+        builder.adapter adapter
+      end
+    end
+
+    def consumer
+      default_options = {
+        :site => endpoint,
+        :access_token_path => '/api/oauth/access_token'
+      }
+      @consumer ||= ::OAuth::Consumer.new(consumer_key, consumer_secret, default_options)
+    end
+
+    def access_token
+      @access_token ||= consumer.get_access_token(nil, {}, {
+        :x_auth_mode => 'client_auth',
+        :x_auth_username => xauth_username,
+        :x_auth_password => xauth_password
+      })
+    end
+  end
+end

data/lib/cliskip2/request/oauth.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+require 'faraday'
+require 'simple_oauth'
+
+module Cliskip2
+  module Request
+    class Cliskip2OAuth < FaradayMiddleware::OAuth
+      # Override Faraday::Utils#parse_nested_query for fixing base-query-string
+      # body部分のパラメタ解析方法がskip2のSPで利用しているoauth(0.4.1)とfaradayのoauthモジュールとで異なってしまい認証がうまくいかないためfaraday側のbody部分解析をoauth(0.4.1)相当に合わせている
+      # See Faraday::Utils, FaradayMiddleware::OAuth
+      def parse_nested_query(qs)
+        params = {}
+        (qs || '').split(/[&;] */n).each do |p|
+          k, v = p.split('=', 2).map { |s| unescape(s) }
+          params[k] = v
+        end
+        params
+      end
+      def unescape(s) CGI.unescape s.to_s end
+
+      # Override Faraday::Utils#include_body_params?
+      # oauth(0.4.1)でpostの場合のみbodyをsignature-base-stringに含めているので
+      def include_body_params?(env)
+        # see RFC 5489, section 3.4.1.3.1 for details
+        env[:method] == :post && (!(type = env[:request_headers][CONTENT_TYPE]) or type == TYPE_URLENCODED)
+      end
+    end
+  end
+end
+

data/lib/cliskip2/request.rb

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+module Cliskip2
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP DELETE request
+    def delete(path, params={}, options={})
+      request(:delete, path, params, options)
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params={}, options={})
+      request(:get, path, params, options)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params={}, options={})
+      request(:post, path, params, options)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, params={}, options={})
+      request(:put, path, params, options)
+    end
+
+  private
+
+    # Perform an HTTP request
+    def request(method, path, params, options)
+      response = connection(options).run_request(method, nil, nil, nil) do |request|
+        request.options[:raw] = true if options[:raw]
+        case method.to_sym
+        when :delete, :get
+          request.url(path, params)
+        when :post, :put
+          request.path = path
+          request.body = params unless params.empty?
+        end
+      end
+      options[:raw] ? response : response.body
+    end
+
+  end
+end

data/lib/cliskip2/user.rb

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+require 'cliskip2/base'
+
+module Cliskip2
+  class User < Cliskip2::Base
+    lazy_attr_reader :id, :tenant_id, :email
+  end
+end

data/lib/cliskip2/version.rb

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

data/lib/cliskip2.rb

@@ -0,0 +1,15 @@
+require "cliskip2/version"
+require 'cliskip2/client'
+require 'cliskip2/config'
+
+module Cliskip2
+  extend Config
+  class << self
+    # Alias for Cliskip2::Client.new
+    #
+    # @return [Cliskip2::Client]
+    def new(options={})
+      Cliskip2::Client.new(options)
+    end
+  end
+end

data/spec/cliskip2_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Cliskip2" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'cliskip2'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification 
+name: cliskip2
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Naoki Maeda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-04 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :runtime
+  name: faraday_middleware
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 1
+        - 8
+        version: 0.1.8
+  type: :runtime
+  name: simple_oauth
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 7
+        - 3
+        version: 1.7.3
+  type: :runtime
+  name: json
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
+  type: :runtime
+  name: oauth
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rake
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rake-compiler
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :development
+  name: rspec
+  prerelease: false
+  version_requirements: *id007
+description: A Ruby wrapper for the SKIP2 REST APIs
+email: 
+- maeda.na@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- cliskip2.gemspec
+- lib/cliskip2.rb
+- lib/cliskip2/base.rb
+- lib/cliskip2/client.rb
+- lib/cliskip2/config.rb
+- lib/cliskip2/connection.rb
+- lib/cliskip2/request.rb
+- lib/cliskip2/request/oauth.rb
+- lib/cliskip2/user.rb
+- lib/cliskip2/version.rb
+- spec/cliskip2_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://wiki.github.com/maedana/cliskip2
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: cliskip2
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the SKIP2 REST APIs
+test_files: []
+