feedly_api 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 405308a3fdd8fa2af2f1e876fe90818920269ffb
-  data.tar.gz: a573029f11f75f6384b09603e5904f3912bec219
+  metadata.gz: 43a7715f0add0564eacbedfd563c66f1756b46c7
+  data.tar.gz: 61c1853e5aa7cddfb0514a39a05996650cbb7781
 SHA512:
-  metadata.gz: d3d47994b7708357079bb72eaac8106a83f4b41f2bdc4f7c431ed35e89bfc6c68d301ca862a964d77afa9984866b4b441a92fae97374fd1c9eba1f1afd68eaba
-  data.tar.gz: 1776e3b5b6e5f9e94f2a5ae7f7e506470084e7522ead049f50c7fdaf9584ffe31a5f5ddb5f8b295a1a3dbf934d8e93aebcdd7f0c117221f81824dfd4670a85d9
+  metadata.gz: 9d695edda17f345ad9c2f99c36bf3e78f77a12873ba9745ad7557228ef0b75121ce9ba4d4ae438f868c946dd4c65b1d931f29de76c39243b0b72ae9fa45f19d1
+  data.tar.gz: 5aa2b7af45b8a65b8bff4ce0369f6225b11edc36a73998acfc30b4c783b8796c7970a7034b9e8a640aeacb7279d8a6718980af1a63e541515ac8e1fb95e78bf3

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 2013-07-16
+* Change API, add requests with auth token

data/README.md

@@ -13,43 +13,28 @@ Early unofficial Feedly API with no external dependencies
 
 ```ruby
 feedly = FeedlyApi::Client.new 
-=> #<FeedlyApi::Client:0xb91fed0c @auth_token=nil>
-feed = feedly.feed 'https://www.eff.org/rss/updates.xml'
-=> #<FeedlyApi::Feed:0xb90aef38
- @subscribers=2348,
- @title="Deeplinks",
- @url="https://www.eff.org/rss/updates.xml",
- @velocity=15.2>
-feed.items
-=> [{:id=>
-   "55jQyVFBayOwBJQ5qCX8DsgTPumTnzjw6LozTAKPiWA=_13fa6b1134b:1a10f:eacbe387",
-  :originId=>"74790 at https://www.eff.org",
-  :fingerprint=>"2a5c0169",
-  :title=>"Weev's Case Flawed From Beginning to End",
-  :published=>1372888846000, 
+=> #<FeedlyApi::Client:0x007ff233308ae0 @auth_token=nil>
+client.get_feed_info 'feed/https://www.eff.org/rss/updates.xml'
+=> {:website=>"https://www.eff.org/rss/updates.xml",
+ :id=>"feed/https://www.eff.org/rss/updates.xml",
+ :subscribers=>2442,
+ :title=>"Deeplinks",
+ :velocity=>15.2}
+client.get_feed_contents 'feed/https://www.eff.org/rss/updates.xml'
+=> {:direction=>"ltr",
+ :continuation=>"13fa6b1134b:1a10f:eacbe387",
+ :alternate=>
+  [{:href=>"https://www.eff.org/rss/updates.xml", :type=>"text/html"}],
+ :id=>"feed/https://www.eff.org/rss/updates.xml",
+ :updated=>1373935361457,
+ :title=>"Deeplinks",
+ :items=>
+  [{:id=> 
   # ...
-feed.items(ranked: 'oldest')
-=> [{:id=>
-   "55jQyVFBayOwBJQ5qCX8DsgTPumTnzjw6LozTAKPiWA=_13f12b61e62:1a2a50:4b1c86ed",
-  :originId=>"74409 at https://www.eff.org",
-  :fingerprint=>"20f13975",
-  :title=>
-   "Taiwanese Users Thwart Government Plans to Introduce Internet
-Blacklist Law",
-  :published=>1370282860000,
-  # ...
-feed.items.length
-=> 20
-feed.items(count: 50, ranked: 'oldest').length
-=> 50
+client.get_feed_contents('feed/https://www.eff.org/rss/updates.xml', count: 1).size
+=> 1
 ```
 
-List of params you can pass to `items` method:
-* `ranked`: 'oldest', 'newest'
-* `count`: integer, number of feed items to return (1..1000)
-* `continuation`: string
-* maybe some other params...
-
 ## Supported Ruby Versions
 
 feedly_api is tested under 1.9.3, 2.0.0, JRuby (1.9 mode), and Rubinius (1.9 mode).

data/Rakefile

@@ -2,8 +2,8 @@
 
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new do |t|
-    t.rspec_opts = '--color --format doc'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--color --format doc'
 end
 
 task default: :spec

data/lib/feedly_api.rb

@@ -6,6 +6,8 @@ require 'feedly_api/client'
 require 'feedly_api/feed'
 
 module FeedlyApi
+  # A Ruby client library for Feedly Reader
+
   API_ENDPOINT = 'http://cloud.feedly.com/v3/'.freeze
 
   class << self
@@ -22,6 +24,10 @@ module FeedlyApi
         http.request(req)
       end
 
+      handle_errors(response)
+    end
+
+    def handle_errors(response)
       raise BadRequest if 'null' == response.body
 
       case response.code.to_i
@@ -30,7 +36,7 @@ module FeedlyApi
       when 403 then raise AuthError
       when 404 then raise NotFound
       when 500 then raise Error
-      else 
+      else
         raise Error
       end
     end

data/lib/feedly_api/client.rb

@@ -14,11 +14,16 @@ module FeedlyApi
       get_user_profile[:id]
     end
 
+    def feed(feed_id)
+      data = get_feed_info(feed_id)
+      FeedlyApi::Feed.new data
+    end
+
     private
 
     def make_request(path, argv = {})
       url = FeedlyApi::API_ENDPOINT + path + '?'
-      argv.each do |k,v|
+      argv.each do |k, v|
         url << "#{k}=#{v}&"
       end
       # p url

data/lib/feedly_api/feed.rb

@@ -1,22 +1,21 @@
 module FeedlyApi
   class Feed
-    attr_reader :url, :subscribers, :title, :velocity, :id
+    attr_reader :website,
+                :subscribers,
+                :title,
+                :velocity,
+                :id
 
-    def initialize(url)
-      @url = url
-      @id  = "feed%2F#{CGI.escape(@url)}"
-      get_info
+    def initialize(data)
+      @website     = data.fetch(:website)
+      @subscribers = data.fetch(:subscribers)
+      @title       = data.fetch(:title)
+      @velocity    = data.fetch(:velocity)
+      @id          = data.fetch(:id)
     end
 
-    def get_info
-      json = Api.fetch(:feeds, @id)
-      @subscribers = json.fetch(:subscribers) { nil }
-      @title       = json.fetch(:title) { nil }
-      @velocity    = json.fetch(:velocity) { nil }
-    end
-
-    def items(params = {})
-      Api.fetch(:streams, @id, params).fetch(:items)
+    def items
+      []
     end
   end
 end

data/lib/feedly_api/feed_item.rb

@@ -0,0 +1,5 @@
+module FeedlyApi
+  class FeedItem
+
+  end
+end

data/lib/feedly_api/version.rb

@@ -1,3 +1,3 @@
 module FeedlyApi
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/spec/lib/feedly_api/client_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe FeedlyApi::Client do
+end

data/spec/lib/feedly_api/feed_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe FeedlyApi::Feed do
+  let(:feed_data) { {website: 'https://www.eff.org/rss/updates.xml', subscribers: 2443,
+    title: 'Deeplinks', velocity: 15.2,
+    id: 'feed/https://www.eff.org/rss/updates.xml' }
+  }
+  let(:feed) { FeedlyApi::Feed.new(feed_data) }
+
+  describe '#new' do
+    it 'stores website' do
+      expect(feed.website).to eq 'https://www.eff.org/rss/updates.xml'
+    end
+
+    it 'stores subscribers' do
+      expect(feed.subscribers).to eq 2443
+    end
+
+    it 'stores title' do
+      expect(feed.title).to eq 'Deeplinks'
+    end
+
+    it 'stores velocity' do
+      expect(feed.velocity).to eq 15.2
+    end
+
+    it 'stores id' do
+      expect(feed.id).to eq 'feed/https://www.eff.org/rss/updates.xml'
+    end
+  end
+
+  describe '#items' do
+    it 'returns feed items'
+    # it 'returns feed items' do
+    #   expect(feed.items.size).to eq 20
+    # end
+
+    it 'returns certain amount of feed items'
+    it 'returns feed items in certain order'
+  end
+end

data/spec/lib/feedly_api_spec.rb

@@ -1,13 +1,14 @@
 require 'spec_helper'
 
 describe FeedlyApi::Client do
+  do_stub = ENV['FEEDLY_API_BYPASS_STUBS'].nil?
   let(:auth_token) { ENV['FEEDLY_TOKEN'] || 'GREATE_AUTH_TOKEN' }
   let(:user_id)    { ENV['FEEDLY_USER_ID'] || '00000000-000-NOT-VALID-a29b6679bb3c' }
   let(:client)     { FeedlyApi::Client.new auth_token }
 
   describe '#new' do
     before :each do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'profile.json')))
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'profile.json'))) if do_stub
     end
 
     it 'creates Client object with given token' do
@@ -23,14 +24,14 @@ describe FeedlyApi::Client do
   describe '#get_user_profile' do
     # rewrite for more accurancy
     it 'returns user info' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'profile.json')))
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'profile.json'))) if do_stub
       expect(client.get_user_profile[:client]).to eq 'feedly'
     end
   end
 
   describe '#get_feed_info' do
     it 'retrievs basic feed info' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_info.json')))
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_info.json'))) if do_stub
       feed_info = client.get_feed_info('feed/https://www.eff.org/rss/updates.xml')
       expect(feed_info[:website]).to eq 'https://www.eff.org/rss/updates.xml'
     end
@@ -38,20 +39,20 @@ describe FeedlyApi::Client do
 
   describe '#get_subscriptions' do
     it 'retrievs user subscriptions' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'subscriptions.json')))
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'subscriptions.json'))) if do_stub
       expect(client.get_subscriptions.size).to eq 3
     end
   end
 
   describe '#get_feed_contents' do
     it 'retrievs feed contents' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_contents_20.json')))
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_contents_20.json'))) if do_stub
       feed_contents = client.get_feed_contents('feed/https://www.eff.org/rss/updates.xml')
       expect(feed_contents[:items].size).to eq 20
     end
 
     it 'retrievs custom number of feed items' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_contents_10.json')))
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_contents_10.json'))) if do_stub
       feed_contents = client.get_feed_contents('feed/https://www.eff.org/rss/updates.xml', {count: 10})
       expect(feed_contents[:items].size).to eq 10
     end
@@ -63,7 +64,7 @@ describe FeedlyApi::Client do
 
   describe '#get_tag_contents' do
     it 'retrievs content for specific tag' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'tagged.json')))
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'tagged.json'))) if do_stub
       feed_contents = client.get_tag_contents('global.saved')
       expect(feed_contents[:items].size).to eq 1
     end
@@ -77,13 +78,13 @@ describe FeedlyApi::Client do
 
   describe '#get_category_contents' do
     it 'retrievs content for custom category_id' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'uncategoriezed.json')))
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'uncategoriezed.json'))) if do_stub
       feed_contents = client.get_category_contents('global.uncategorized')
       expect(feed_contents[:items].size).to eq 16
     end
 
     it 'retrievs custom number of feed items for specific category_id' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'uncategoriezed_10.json')))
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'uncategoriezed_10.json'))) if do_stub
       feed_contents = client.get_category_contents('global.uncategorized', {count: 10})
       expect(feed_contents[:items].size).to eq 10
     end
@@ -91,8 +92,15 @@ describe FeedlyApi::Client do
 
   describe '#get_markers' do
     it 'returns unred counts for all feeds' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'markers.json')))
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'markers.json'))) if do_stub
       expect(client.get_markers[:unreadcounts].last[:count]).to eq 16
     end
   end
+
+  describe '#feed' do
+    it 'returns Feed object for current feed id' do
+      feed = client.feed('feed/https://www.eff.org/rss/updates.xml')
+      expect(feed).to be_instance_of(FeedlyApi::Feed)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feedly_api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Myuzu
@@ -75,6 +75,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -85,6 +86,7 @@ files:
 - lib/feedly_api/client.rb
 - lib/feedly_api/errors.rb
 - lib/feedly_api/feed.rb
+- lib/feedly_api/feed_item.rb
 - lib/feedly_api/version.rb
 - spec/fixtures/feed_contents_10.json
 - spec/fixtures/feed_contents_20.json
@@ -95,6 +97,9 @@ files:
 - spec/fixtures/tagged.json
 - spec/fixtures/uncategoriezed.json
 - spec/fixtures/uncategoriezed_10.json
+- spec/lib/feedly_api/client_spec.rb
+- spec/lib/feedly_api/feed_item_spec.rb
+- spec/lib/feedly_api/feed_spec.rb
 - spec/lib/feedly_api_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Myuzu/feedly_api