plurky 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef8f40f7f9ca48b65f13082ea8f60eac0bff4f2f
-  data.tar.gz: 1a9bc7e527e2d793c3a73ee3223cd8363e16a8c0
+  metadata.gz: 1e3653b3e77fb39e242f9acdd7ab436e0c1d5145
+  data.tar.gz: 770c3bc16d9eec76592317d6f0483bc1d7b5ac9e
 SHA512:
-  metadata.gz: 6aa1a8ca92439966215e2814baa6243ae932701c51546a8856893048b4656fa4c303ae3309e24e42701778b285196b07ac75fb84cb63fad47cd8d1a23bb42077
-  data.tar.gz: 4233c96b0e1bc085fafd148e9000d96f152deccc5bdcfeb4f84c5e35c04fb4e192a70887797e186a02d354e8388f81523044c1f40cded60abde4a39a03705833
+  metadata.gz: 3144972a478ce0bed3c6464ca5276d4ee74e1e4cee5d370fe42d1c06eb09e824a2a5424195b7cfd3a36ee5d16168d7e621ac5c213e0fc837d231b6eaec04f0ce
+  data.tar.gz: 00a813bcbbbd046bcf531bef4bcfc52141d77d3634fd2622b8deb7d92b5fa50d22b2583363f4ed86e92b8ea755f2488fddc7e61c89c68b39691db9404c206d1a

data/.rspec

@@ -1,3 +1,4 @@
 --color
+--fail-fast
 --order random
 --format doc

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Chun-wei Kuo
+Copyright (c) 2012 - 2013 Chun-wei Kuo
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -33,7 +33,7 @@ Or install it yourself as:
 * This gem: http://rdoc.info/gems/plurky
 * Plurk API 2.0: http://www.plurk.com/API
 
-## Usage
+## Examples
 
 ```ruby
 require 'plurky'
@@ -70,11 +70,21 @@ After configuration, requests can be made like so:
 Plurky.get '/APP/Timeline/getPlurks'
 ```
 
+## Implemented APIs
+
+* status
+
+## The access token
+
+Plurky will not support obtaining access token.
+You can get it from the [test console][].
+
+[test console]: http://www.plurk.com/OAuth/test
+
 ## TODO
 
-* Complete the tests.
+* Improve test coverage.
 * Add APIs.
-* Add support of obtaining access token.
 
 ## Credits
 
@@ -84,7 +94,7 @@ Most of the code are copy-pasted from the [twitter][] gem.
 
 ## Copyright
 
-Copyright (c) 2013 Chun-wei Kuo. See [LICENSE][] for details.
+Copyright (c) 2012 - 2013 Chun-wei Kuo. See [LICENSE][] for details.
 
 [license]: https://github.com/Domon/plurky/blob/master/LICENSE.md
 

data/lib/plurky/api.rb

@@ -0,0 +1,7 @@
+require 'plurky/api/timeline'
+
+module Plurky
+  module API
+    include Plurky::API::Timeline
+  end
+end

data/lib/plurky/api/timeline.rb

@@ -0,0 +1,27 @@
+module Plurky
+  module API
+    module Timeline
+      # Returns a status
+      #
+      # @see http://www.plurk.com/API#/APP/Timeline/getPlurk
+      # @return [Hashie::Mash] The requested status.
+      # @param id [Integer] A status ID.
+      # @example Return the status with the ID 1001647781
+      #   Plurky.status(1001647781)
+      def status(id)
+        object_from_response(:get, "/APP/Timeline/getPlurk", { :plurk_id => id }).plurk
+      end
+
+      private
+
+      # @param method [Symbol]
+      # @param url [String]
+      # @param params [Hash]
+      # @return [Hashie::Mash]
+      def object_from_response(method, url, params = {})
+        response = send(method, url, params)
+        response[:body]
+      end
+    end
+  end
+end

data/lib/plurky/client.rb

@@ -1,10 +1,13 @@
 require 'faraday'
 require 'simple_oauth'
 require 'uri'
+require 'plurky/api'
 require 'plurky/configurable'
 
 module Plurky
+  # Wrapper for the Plurk API 2.0
   class Client
+    include Plurky::API
     include Plurky::Configurable
 
     # Initializes a new Client object

data/lib/plurky/version.rb

@@ -1,3 +1,3 @@
 module Plurky
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/plurky.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'hashie',       '~> 2.0.5'
 
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec', '~> 2.14.0.rc1'
   gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'pry-nav'
   gem.add_development_dependency 'coveralls'

data/spec/fixtures/status.json

@@ -0,0 +1 @@
+{"plurk_users": {"1": {"verified_account": false, "default_lang": "en", "display_name": "amix", "dateformat": 0, "nick_name": "amix", "has_profile_image": 1, "location": "", "bday_privacy": 2, "date_of_birth": "Mon, 13 May 1985 00:01:00 GMT", "karma": 69.6, "full_name": "Amir Salihefendic", "gender": 1, "name_color": "0A9C17", "timezone": "Europe\/Amsterdam", "id": 1, "avatar": 34}}, "user": {"verified_account": false, "default_lang": "en", "display_name": "amix", "dateformat": 0, "nick_name": "amix", "has_profile_image": 1, "location": "", "bday_privacy": 2, "date_of_birth": "Mon, 13 May 1985 00:01:00 GMT", "karma": 69.6, "full_name": "Amir Salihefendic", "gender": 1, "name_color": "0A9C17", "timezone": "Europe\/Amsterdam", "id": 1, "avatar": 34}, "plurk": {"replurkers_count": 4, "replurkable": true, "favorite_count": 6, "is_unread": 0, "favorers": [24228, 89434, 3184175, 3633219, 5386772, 6693159], "user_id": 1, "plurk_type": 0, "replurked": false, "content": "<a href=\"http:\/\/ridiculousfish.com\/shell\/index.html\" class=\"ex_link\" rel=\"nofollow\">Finally, a command line shell for the 90s<\/a> <img class=\"emoticon_my\" src=\"http:\/\/emos.plurk.com\/b6ebb0a088fa352ee03ed6f760fb319d_w16_h16.png\" width=\"16\" height=\"16\" \/>", "replurker_id": null, "owner_id": 1, "responses_seen": 0, "qualifier": "likes", "plurk_id": 1001647781, "response_count": 8, "limited_to": null, "no_comments": 0, "posted": "Wed, 06 Jun 2012 12:37:42 GMT", "lang": "en", "content_raw": "http:\/\/ridiculousfish.com\/shell\/index.html (Finally, a command line shell for the 90s) http:\/\/emos.plurk.com\/b6ebb0a088fa352ee03ed6f760fb319d_w16_h16.png", "replurkers": [23118, 3184175, 4853404, 6649986], "favorite": true}}

data/spec/plurky/api/timeline_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Plurky::API::Timeline do
+  subject(:client) { Plurky::Client.new }
+
+  describe "#status" do
+    before do
+      stub_get("/APP/Timeline/getPlurk", :plurk_id => 1001647781).
+        to_return(json_response("status.json"))
+    end
+
+    it "requests the correct resource" do
+      client.status(1001647781)
+      expect(a_get("/APP/Timeline/getPlurk", :plurk_id => 1001647781)).to have_been_made
+    end
+
+    it "returns a correct Hashie::Mash" do
+      status = client.status(1001647781)
+      expect(status).to be_a Hashie::Mash
+      expect(status.content_raw).to eq "http://ridiculousfish.com/shell/index.html (Finally, a command line shell for the 90s) http://emos.plurk.com/b6ebb0a088fa352ee03ed6f760fb319d_w16_h16.png"
+    end
+  end
+
+end

data/spec/plurky/client_spec.rb

@@ -10,7 +10,7 @@ describe Plurky::Client do
     }
   end
 
-  subject { Plurky::Client.new(configuration) }
+  subject(:client) { Plurky::Client.new(configuration) }
 
   context "with module configuration" do
     before do
@@ -26,9 +26,9 @@ describe Plurky::Client do
     end
 
     it "inherits the module configuration" do
-      client = Plurky.client
+      cached_client = Plurky.client
       configuration.each do |key, value|
-        client.instance_variable_get(:"@#{key}").should == value
+        expect(cached_client.instance_variable_get(:"@#{key}")).to eq value
       end
     end
 
@@ -37,9 +37,9 @@ describe Plurky::Client do
       let(:different_configuration) { configuration.update :oauth_token_secret => 'OS' }
 
       it "overrides the module configuration" do
-        client = Plurky::Client.new(different_configuration)
+        different_client = Plurky::Client.new(different_configuration)
         different_configuration.each do |key, value|
-          client.instance_variable_get(:"@#{key}").should == value
+          expect(different_client.instance_variable_get(:"@#{key}")).to eq value
         end
       end
 
@@ -48,12 +48,13 @@ describe Plurky::Client do
 
   describe "#credentials?" do
     it "returns true if all credentials are present" do
-      client = Plurky::Client.new(configuration)
-      client.credentials?.should be_true
+      client_with_all_credentials = Plurky::Client.new(configuration)
+      expect(client_with_all_credentials.credentials?).to 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
+      client_with_missing_credentials =
+        Plurky::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT')
+      expect(client_with_missing_credentials.credentials?).to be_false
     end
   end
 
@@ -62,8 +63,8 @@ describe Plurky::Client do
     let(:params) { { :user => 34 } }
 
     it "knows how to make get request" do
-      subject.should_receive(:request).with(:get, path, params)
-      subject.get path, params
+      expect(client).to receive(:request).with(:get, path, params)
+      client.get path, params
     end
   end
 
@@ -72,14 +73,14 @@ describe Plurky::Client do
     let(:params) { { :image => "" } }
 
     it "knows how to make post request" do
-      subject.should_receive(:request).with(:post, path, params)
-      subject.post path, params
+      expect(client).to receive(:request).with(:post, path, params)
+      client.post path, params
     end
   end
 
   describe "#connection" do
     it "looks like Faraday connection" do
-      subject.send(:connection).should respond_to(:run_request)
+      expect(client.send(:connection)).to respond_to(:run_request)
     end
   end
 
@@ -89,13 +90,13 @@ describe Plurky::Client do
   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"
+      authorization = client.send(:auth_header, :get, uri, { :user_id => 34 })
+      expect(authorization.options[:signature_method]).to eq "HMAC-SHA1"
+      expect(authorization.options[:version]).to          eq "1.0"
+      expect(authorization.options[:consumer_key]).to     eq "CK"
+      expect(authorization.options[:consumer_secret]).to  eq "CS"
+      expect(authorization.options[:token]).to            eq "OT"
+      expect(authorization.options[:token_secret]).to     eq "OTS"
     end
   end
 

data/spec/plurky_spec.rb

@@ -4,12 +4,12 @@ describe Plurky do
 
   describe ".client" do
     it "returns a Plurky::Client" do
-      Plurky.client.should be_a Plurky::Client
+      expect(Plurky.client).to be_a Plurky::Client
     end
 
     context "when the options don't change" do
       it "caches the client" do
-        Plurky.client.should == Plurky.client
+        expect(Plurky.client).to eq Plurky.client
       end
     end
 
@@ -21,15 +21,18 @@ describe Plurky do
           config.consumer_secret = 'CS'
         end
         client2 = Plurky.client
-        client1.should_not == client2
+        expect(client1).not_to eq client2
       end
     end
   end
 
   describe ".respond_to?" do
     it "delegates to Plurky::Client" do
-      Plurky.should respond_to :get
+      expect(Plurky).to respond_to :get
     end
   end
 
+  describe ".configure" do
+  end
+
 end

data/spec/spec_helper.rb

@@ -6,4 +6,41 @@ require 'webmock/rspec'
 require 'plurky'
 
 RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    # Enable only the `expect` syntax
+    c.syntax = :expect
+  end
+end
+
+def plurk_url(path)
+  URI.join(Plurky::Default::ENDPOINT, path).to_s
+end
+
+def a_get(path, query = {})
+  a_request(:get, plurk_url(path)).with(:query => query)
+end
+
+def stub_get(path, query = {})
+  stub_request(:get, plurk_url(path)).with(:query => query)
+end
+
+def fixtures_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture_path(file)
+  File.join(fixtures_path, file)
+end
+
+def fixture(file)
+  File.new(fixture_path(file))
+end
+
+def json_response(file)
+  {
+    :body => fixture(file),
+    :headers => {
+      :content_type => "application/json; charset=utf-8"
+    }
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plurky
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Chun-wei Kuo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-05 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -84,16 +84,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.0.rc1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -151,13 +151,18 @@ files:
 - README.md
 - Rakefile
 - lib/plurky.rb
+- lib/plurky/api.rb
+- lib/plurky/api/timeline.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/status.rb
 - lib/plurky/version.rb
 - plurky.gemspec
+- spec/fixtures/status.json
+- spec/plurky/api/timeline_spec.rb
 - spec/plurky/client_spec.rb
 - spec/plurky_spec.rb
 - spec/spec_helper.rb
@@ -185,6 +190,8 @@ signing_key:
 specification_version: 4
 summary: Yet another Plurk API wrapper
 test_files:
+- spec/fixtures/status.json
+- spec/plurky/api/timeline_spec.rb
 - spec/plurky/client_spec.rb
 - spec/plurky_spec.rb
 - spec/spec_helper.rb