plurky 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40f33d5e82d63deb9bb4439dc315cd45666c5c06
+  data.tar.gz: 1b59ba2b8f1305237f039756018f05e990786c97
+SHA512:
+  metadata.gz: b73fbaa28eace153210a838aeac0fd88059ce6e1d4a54c4c2cd2d2ce55aed9d7f96baa934027bbcd47ef8419739c92da5afec5323e84c530428a661055607db3
+  data.tar.gz: 8fe93ebba45058ba2d52f1955192762682b404a980c186a5f39a224a40e92b3a8d545faf726680a179934b61401a9c4ee191ab20817ab8cf70bf10f80938fd79

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/.rspec

@@ -0,0 +1,3 @@
+--color
+--order random
+--format doc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chun-wei Kuo
+
+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,78 @@
+# Plurky
+
+Yet another Plurk API wrapper. Or something to play when the Plurk team is busy optimizing the site.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'plurky'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install plurky
+
+## Documentation
+
+* This gem: http://rdoc.info/gems/plurky
+* Plurk API 2.0: http://www.plurk.com/API
+
+## Usage
+
+```ruby
+require 'plurky'
+
+client = Plurky.client
+client.get '/APP/Profile/getPublicProfile', :user_id => 34
+```
+
+## Configuration
+
+Applications that make requests on behalf of a single Plurk user can pass global configuration options as a block to the `Plurky.configure` method.
+
+```ruby
+Plurky.configure do |config|
+  config.consumer_key       = YOUR_CONSUMER_KEY
+  config.consumer_secret    = YOUR_CONSUMER_SECRET
+  config.oauth_token        = YOUR_OAUTH_TOKEN
+  config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
+end
+```
+
+Alternately, you can set the following environment variables:
+
+```
+PLURK_CONSUMER_KEY
+PLURK_CONSUMER_SECRET
+PLURK_OAUTH_TOKEN
+PLURK_OAUTH_TOKEN_SECRET
+```
+
+After configuration, requests can be made like so:
+
+```ruby
+Plurky.get '/APP/Timeline/getPlurks'
+```
+
+## TODO
+
+* Complete the tests.
+* Add APIs.
+* Add support of obtaining access token.
+
+## Credits
+
+Most of the code are copy-pasted from the [twitter][] gem.
+
+[twitter]: https://github.com/sferik/twitter
+
+## Copyright
+
+Copyright (c) 2012 Chun-wei Kuo. See [LICENSE][] for details.
+
+[license]: https://github.com/Domon/plurky/blob/master/LICENSE.md
+

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/plurky.rb

@@ -0,0 +1,33 @@
+require 'plurky/client'
+require 'plurky/configurable'
+require 'plurky/version'
+
+module Plurky
+  class << self
+    include Plurky::Configurable
+
+    # Delegate to a Plurky::Client
+    #
+    # @return [Plurky::Client]
+    def client
+      @client = Plurky::Client.new(options) unless defined?(@client) && @client.cache_key == options.hash
+      @client
+    end
+
+    # Delegate to Plurky::Client
+    #
+    def respond_to?(method, include_private = false)
+      client.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+  end
+end
+
+Plurky.setup

data/lib/plurky/client.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+require 'simple_oauth'
+require 'uri'
+require 'plurky/configurable'
+
+module Plurky
+  class Client
+    include Plurky::Configurable
+
+    # Initializes a new Client object
+    #
+    # @param options [Hash]
+    # @return [Plurky::Client]
+    def initialize(options = {})
+      Plurky::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Plurky.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params = {})
+      request(:post, path, params)
+    end
+
+    private
+
+    # Returns a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new(@endpoint, @connection_options.merge(:builder => @middleware))
+    end
+
+    # Perform an HTTP request
+    def request(method, path, params = {})
+      request_headers = {}
+      if credentials?
+        uri = URI(@endpoint) + path
+        authorization = auth_header(method, uri, params)
+        request_headers[:authorization] = authorization.to_s
+      end
+
+      response = connection.run_request(method, path, nil, request_headers) do |request|
+        unless params.empty?
+          case request.method
+          when :post, :put
+            request.body = params
+          else
+            request.params.update(params)
+          end
+        end
+      end
+      response.env
+    end
+
+    def auth_header(method, uri, params = {})
+      signature_params = [:post, :put].include?(method) && params.values.any? { |value| value.respond_to?(:to_io) } ? {} : params
+      SimpleOAuth::Header.new(method, uri, signature_params, credentials)
+    end
+
+  end
+end

data/lib/plurky/configurable.rb

@@ -0,0 +1,63 @@
+require 'plurky/default'
+
+module Plurky
+  module Configurable
+    attr_writer :consumer_key, :consumer_secret, :oauth_token, :oauth_token_secret
+
+    class << self
+      def keys
+        @keys ||= [
+          :consumer_key,
+          :consumer_secret,
+          :oauth_token,
+          :oauth_token_secret,
+          :endpoint,
+          :connection_options,
+          :middleware
+        ]
+      end
+    end
+
+    # Allow configuration options to be set in a block
+    def configure
+      yield self
+      self
+    end
+
+    # @return [Boolean]
+    def credentials?
+      credentials.values.all?
+    end
+
+    # @return [Fixnum]
+    def cache_key
+      options.hash
+    end
+
+    def reset!
+      Plurky::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Plurky::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+    private
+
+    # @return [Hash]
+    def credentials
+      {
+        :consumer_key    => @consumer_key,
+        :consumer_secret => @consumer_secret,
+        :token           => @oauth_token,
+        :token_secret    => @oauth_token_secret
+      }
+    end
+
+    # @return [Hash]
+    def options
+      Hash[Plurky::Configurable.keys.map{ |key| [key, instance_variable_get(:"@#{key}")] }]
+    end
+
+  end
+end

data/lib/plurky/default.rb

@@ -0,0 +1,76 @@
+require 'plurky/configurable'
+require 'plurky/response/parse_json'
+require 'plurky/response/mashify'
+require 'plurky/version'
+
+module Plurky
+  module Default
+    ENDPOINT = 'http://www.plurk.com/'
+
+    CONNECTION_OPTIONS = {
+      :headers => {
+        :accept => 'application/json',
+        :user_agent => "Plurky Ruby Gem #{Plurky::VERSION}"
+      },
+      :open_timeout => 5,
+      :raw => true,
+      :ssl => { :verify => false },
+      :timeout => 10
+    }
+
+    MIDDLEWARE = Faraday::Builder.new(
+      &Proc.new do |builder|
+        builder.use Faraday::Request::Multipart
+        builder.use Faraday::Request::UrlEncoded
+
+        builder.use Plurky::Response::Mashify
+        builder.use Plurky::Response::ParseJson
+        builder.adapter Faraday.default_adapter
+      end
+    )
+
+    class << self
+
+      # @return [String]
+      def consumer_key
+        ENV['PLURK_CONSUMER_KEY']
+      end
+
+      # @return [String]
+      def consumer_secret
+        ENV['PLURK_CONSUMER_SECRET']
+      end
+
+      # @return [String]
+      def oauth_token
+        ENV['PLURK_OAUTH_TOKEN']
+      end
+
+      # @return [String]
+      def oauth_token_secret
+        ENV['PLURK_OAUTH_TOKEN_SECRET']
+      end
+
+      # @return [String]
+      def endpoint
+        ENDPOINT
+      end
+
+      # @return [Hash]
+      def connection_options
+        CONNECTION_OPTIONS
+      end
+
+      # @return [Faraday::Builder]
+      def middleware
+        MIDDLEWARE
+      end
+
+      # @return [Hash]
+      def options
+        Hash[Plurky::Configurable.keys.map { |key| [key, send(key)] }]
+      end
+
+    end
+  end
+end

data/lib/plurky/response/mashify.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'hashie/mash'
+
+module Plurky
+  module Response
+    class Mashify < Faraday::Response::Middleware
+
+      def parse(body)
+        case body
+        when Hash
+          Hashie::Mash.new body
+        when Array
+          body.map { |item| item.is_a?(Hash) ? Hashie::Mash.new(item) : item }
+        else
+          body
+        end
+      end
+
+      # Overrides Faraday::Response::Middleware#on_complete
+      def on_complete(env)
+        unless [204, 301, 302, 304].include?(env[:status])
+          env[:body] = parse(env[:body])
+        end
+      end
+
+    end
+  end
+end

data/lib/plurky/response/parse_json.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+require 'multi_json'
+
+module Plurky
+  module Response
+    class ParseJson < Faraday::Response::Middleware
+
+      def parse(body)
+        case body
+        when /\A^\s*$\z/, nil
+          nil
+        else
+          MultiJson.load(body, :symbolize_keys => true)
+        end
+      end
+
+      # Overrides Faraday::Response::Middleware#on_complete
+      def on_complete(env)
+        unless [204, 301, 302, 304].include?(env[:status])
+          env[:body] = parse(env[:body])
+        end
+      end
+
+    end
+  end
+end

data/lib/plurky/version.rb

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

data/plurky.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plurky/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "plurky"
+  gem.version       = Plurky::VERSION
+  gem.authors       = ["Chun-wei Kuo"]
+  gem.email         = ["Dendoh@gmail.com"]
+  gem.description   = %q{Yet another Plurk API wrapper}
+  gem.summary       = %q{Yet another Plurk API wrapper}
+  gem.homepage      = "https://github.com/Domon/plurky"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'faraday',      '~> 0.8.4'
+  gem.add_dependency 'simple_oauth', '~> 0.1.9'
+  gem.add_dependency 'multi_json',   '~> 1.3.7'
+  gem.add_dependency 'hashie',       '~> 2.0.5'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'pry-nav'
+end

data/spec/plurky/client_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Plurky::Client do
+  let(:configuration) do
+    {
+      :consumer_key       => 'CK',
+      :consumer_secret    => 'CS',
+      :oauth_token        => 'OT',
+      :oauth_token_secret => 'OTS'
+    }
+  end
+
+  subject { Plurky::Client.new(configuration) }
+
+  context "with module configuration" do
+    before do
+      Plurky.configure do |config|
+        configuration.each do |key, value|
+          config.send("#{key}=", value)
+        end
+      end
+    end
+
+    after do
+      Plurky.reset!
+    end
+
+    it "inherits the module configuration" do
+      client = Plurky.client
+      configuration.each do |key, value|
+        client.instance_variable_get(:"@#{key}").should == value
+      end
+    end
+
+    context "with class configuration" do
+
+      let(:different_configuration) { configuration.update :oauth_token_secret => 'OS' }
+
+      it "overrides the module configuration" do
+        client = Plurky::Client.new(different_configuration)
+        different_configuration.each do |key, value|
+          client.instance_variable_get(:"@#{key}").should == value
+        end
+      end
+
+    end
+  end
+
+  describe "#credentials?" do
+    it "returns true if all credentials are present" do
+      client = Plurky::Client.new(configuration)
+      client.credentials?.should be_true
+    end
+    it "returns false if any credentials are missing" do
+      client = Plurky::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT')
+      client.credentials?.should be_false
+    end
+  end
+
+  describe "#get" do
+    let(:path) { '/APP/Profile/getPublicProfile' }
+    let(:params) { { :user => 34 } }
+
+    it "knows how to make get request" do
+      subject.should_receive(:request).with(:get, path, params)
+      subject.get path, params
+    end
+  end
+
+  describe "#post" do
+    let(:path) { '/APP/Timeline/uploadPicture' }
+    let(:params) { { :image => "" } }
+
+    it "knows how to make post request" do
+      subject.should_receive(:request).with(:post, path, params)
+      subject.post path, params
+    end
+  end
+
+  describe "#connection" do
+    it "looks like Faraday connection" do
+      subject.send(:connection).should respond_to(:run_request)
+    end
+  end
+
+  describe "#request" do
+  end
+
+  describe "#auth_header" do
+    it "creates the correct auth headers" do
+      uri = URI("http://www.plurk.com/APP/Profile/getPublicProfile")
+      authorization = subject.send(:auth_header, :get, uri, { :user_id => 34 })
+      authorization.options[:signature_method].should == "HMAC-SHA1"
+      authorization.options[:version].should          == "1.0"
+      authorization.options[:consumer_key].should     == "CK"
+      authorization.options[:consumer_secret].should  == "CS"
+      authorization.options[:token].should            == "OT"
+      authorization.options[:token_secret].should     == "OTS"
+    end
+  end
+
+end

data/spec/plurky_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Plurky do
+
+  describe ".client" do
+    it "returns a Plurky::Client" do
+      Plurky.client.should be_a Plurky::Client
+    end
+
+    context "when the options don't change" do
+      it "caches the client" do
+        Plurky.client.should == Plurky.client
+      end
+    end
+
+    context "when the options change" do
+      it "creates a new client" do
+        client1 = Plurky.client
+        Plurky.configure do |config|
+          config.consumer_key    = 'CK'
+          config.consumer_secret = 'CS'
+        end
+        client2 = Plurky.client
+        client1.should_not == client2
+      end
+    end
+  end
+
+  describe ".respond_to?" do
+    it "delegates to Plurky::Client" do
+      Plurky.should respond_to :get
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'webmock/rspec'
+require 'plurky'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: plurky
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chun-wei Kuo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !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: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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: Yet another Plurk API wrapper
+email:
+- Dendoh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/plurky.rb
+- lib/plurky/client.rb
+- lib/plurky/configurable.rb
+- lib/plurky/default.rb
+- lib/plurky/response/mashify.rb
+- lib/plurky/response/parse_json.rb
+- lib/plurky/version.rb
+- plurky.gemspec
+- spec/plurky/client_spec.rb
+- spec/plurky_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Domon/plurky
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Yet another Plurk API wrapper
+test_files:
+- spec/plurky/client_spec.rb
+- spec/plurky_spec.rb
+- spec/spec_helper.rb