newsblurry 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f2046f72b33788e1164f9dc67f29dd6ed621fe0
-  data.tar.gz: 58dd9af17bf01649f2cabc6e64157298337dcc0f
+  metadata.gz: caff377bf664d7cbee0a5dce658aac7caa1d9953
+  data.tar.gz: 386323e5f38e7491dcee6dbabcc88917ef385e8c
 SHA512:
-  metadata.gz: a2543e9a04d8bbe80c4e0e2062f0c340a16f74a880d6fda27842876e63aaf8cb61349156f23ab6c4182b924d73e220f07620f1ee77ea5abaaffdf954405a37a5
-  data.tar.gz: 8b8f3b6c35e9f8f0378cb71a355e32f253c9e534d9a64b79be13a2c391c894cc66381c6345b8bc5f4de74c079d8bf2426ee01f59621b5af8a1a62f319f6744a5
+  metadata.gz: fe4c707b18da67891cb3f4308a2e4bebb192f9e33d9d9d4430f86a6e591f975afc9f8c561fe06d35b3b89b0625cafc13ad659bcf6708acb3f866f631b4bc1815
+  data.tar.gz: a18885f67ccb7837a7b80ec8651633f08b17d8903f8610efcc5d23bc9147ef399bc24ab222c362960ece40c7f9b29f9f0a92128d36905844619921825f1f8071

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+## 1.0.0, released 2013-10-11
+* Use Newsblurry::Agent to retrieve unread stories
+
 ## 0.0.1, released 2013-10-06
 * Initial release

data/README.md

@@ -7,7 +7,7 @@
 
 ## Description
 
-Connect to Newsblur
+Connect to Newsblur API using Ruby
 
 ## Installation
 Add this line to your Gemfile
@@ -20,5 +20,16 @@ And then:
 
 ## Usage
 
+Create a new agent with your username and password.
+Use the agent to retrieve your unread stories or mark a story as read.
+
+    agent = Newsblurry::Agent(username, password)
+
+### Return all unread stories for account
+    unread_stories = agent.unread_stories
+
+### Mark a story as read
+    agent.mark_as_read(newsblurry_story_hash)
+
 ## License
 Released under the MIT License

data/lib/newsblurry.rb

@@ -2,9 +2,10 @@ require 'httparty'
 require 'newsblurry/version'
 
 module Newsblurry
+  autoload :Agent, 'newsblurry/agent'
   autoload :Connection, 'newsblurry/connection'
   autoload :Feed, 'newsblurry/feed'
-  autoload :Story, 'newsblurry/story'
   autoload :FeedParser, 'newsblurry/feed_parser'
+  autoload :Story, 'newsblurry/story'
   autoload :StoryParser, 'newsblurry/story_parser'
 end

data/lib/newsblurry/agent.rb

@@ -0,0 +1,16 @@
+module Newsblurry
+  class Agent
+
+    def initialize(username, password)
+      @connection = Newsblurry::Connection.new(username, password)
+    end
+
+    def unread_stories
+      @connection.unread_stories
+    end
+
+    def mark_as_read(story_hash)
+      @connection.mark_as_read(story_hash)
+    end
+  end
+end

data/lib/newsblurry/version.rb

@@ -1,3 +1,3 @@
 module Newsblurry
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end

data/newsblurry.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.email    = 'jgeiger@gmail.com'
   s.homepage = 'http://github.com/jgeiger/newsblurry'
 
-  s.summary     = 'Newsblurry is a Ruby client to access the Newsblur API.'
+  s.summary     = 'Newsblurry is a Ruby client for the Newsblur API.'
   s.description = 'Access your Newsblur feed using Ruby.'
   s.licenses    = ["MIT"]
 

data/spec/newsblurry/agent_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Newsblurry::Agent do
+  before do
+    username = 'test'
+    password = 'test'
+    @connection = double(:connection)
+
+    expect(Newsblurry::Connection).to receive(:new)
+    .and_return(@connection)
+
+    @agent = Newsblurry::Agent.new(username, password)
+  end
+
+  context '#initialize' do
+    it 'creates a Newsblurry::Agent instance' do
+      expect(@agent.class).to eq(Newsblurry::Agent)
+    end
+  end
+
+  context 'when accessing the API' do
+    context '#unread_stories' do
+      it 'calls the connection method for unread_stories' do
+        expect(@connection).to receive(:unread_stories)
+
+        @agent.unread_stories
+      end
+    end
+
+    context '#mark_as_read' do
+      it 'calls the connection method for mark_as_read' do
+        story_hash = '1234:abcd'
+
+        expect(@connection).to receive(:mark_as_read)
+        .with(story_hash)
+
+        @agent.mark_as_read(story_hash)
+      end
+    end
+  end
+end

data/spec/newsblurry/connection_spec.rb

@@ -11,7 +11,7 @@ describe Newsblurry::Connection do
         body: 'password=test&username=test',
         headers: {
           'Cookie' => '',
-          'User-Agent' => 'Newsblurry::Connection - 0.0.1'
+          'User-Agent' => "Newsblurry::Connection - #{Newsblurry::VERSION}",
         }
       )
 

data/spec/newsblurry/version_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe Newsblurry do
   it 'returns the version' do
-    expect(Newsblurry::VERSION).to eq('0.0.1')
+    expect(Newsblurry::VERSION).to eq('1.0.0')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newsblurry
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Joey Geiger
@@ -65,6 +65,7 @@ files:
 - README.md
 - Rakefile
 - lib/newsblurry.rb
+- lib/newsblurry/agent.rb
 - lib/newsblurry/connection.rb
 - lib/newsblurry/feed.rb
 - lib/newsblurry/feed_parser.rb
@@ -76,6 +77,7 @@ files:
 - spec/fixtures/feeds.txt
 - spec/fixtures/mark_as_read_1095_cdeec3.txt
 - spec/fixtures/unread_feed_story_hashes.txt
+- spec/newsblurry/agent_spec.rb
 - spec/newsblurry/connection_spec.rb
 - spec/newsblurry/feed_parser_spec.rb
 - spec/newsblurry/feed_spec.rb
@@ -106,5 +108,5 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Newsblurry is a Ruby client to access the Newsblur API.
+summary: Newsblurry is a Ruby client for the Newsblur API.
 test_files: []