googleplus-reader 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e9af9e59801e32dcf8c902485144e0f35c3d73e
-  data.tar.gz: f6fb7a4f92dbc7c42b46f7ee4b394219d839cea3
+  metadata.gz: 5e6464b486318c333d4c7cc2d89cf54473eef50e
+  data.tar.gz: 0cbc58dfa6382b1f909deefbba0451472f1745b4
 SHA512:
-  metadata.gz: 7890b855a82bb630da6455be5aae72ec05a6b80c6c06f4ffe3e8f356ea85c3cfa64fb9b2c8cac584cec298073d25af4900c9abc30f903f06dd548780daed95ce
-  data.tar.gz: 51ce40677da1a506b25d448351cb165aca378fec5fc2c37ff5a73a167cc0c3c9579a28c4df84d2c6abf00b58307331e475ad0f4017e4d7fd6e8f38481715d6cd
+  metadata.gz: 4d852aacdb87788bb02ef12b4f6d2ce3dc7f4bdfc86ffdd6d6d96f87f8021e5a7f681f59124134f0c5c1bd414eeffca1e88916c9c69e661e142319fb9a7274b8
+  data.tar.gz: ef4541183a576fc8e48755b5f76eb54bf2bcaa6c40b1d529daf8a29e75f3beb6c648cbd728534e84c7457ba5d1bc018c48bdf7e2d36cc30c372d3bb015917484

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## GooglePlus Reader 0.0.4 (August 2, 2014)
+
+* Changed the API to rely on deferreds instead of callbacks.
+
 ## GooglePlus Reader 0.0.3 (August 1, 2014)
 
 * Fixed a cross-domain-related issue discovered in IE9.

data/README.md

@@ -7,9 +7,10 @@ A [jQuery](http://jquery.com)-based library for reading public posts of a
 
 ## Installation
 
-```bash
-$ echo "gem 'googleplus-reader'" >> Gemfile
-$ bundle install
+In `Gemfile`:
+
+```ruby
+gem 'googleplus-reader'
 ```
 
 The code is written in [CoffeeScript](http://coffeescript.org); however,
@@ -19,30 +20,30 @@ have CoffeeScript installed.
 ## Usage
 
 Here is an example in the context of a [Rails](http://rubyonrails.org)
-application. First, we need CoffeeScript as it was noted earlier:
+application.
+
+In `Gemfile`:
 
-```bash
-$ echo "gem 'coffee-rails'" >> Gemfile
-$ bundle install
+```ruby
+gem 'coffee-rails'
 ```
 
-In your `app/views/layouts/application.html.haml`:
+In `app/views/layouts/application.html.haml`:
 
 ```haml
-= javascript_include_tag '//ajax.googleapis.com/ajax/libs/jquery/2.1.0/jquery.min.js'
+= javascript_include_tag '//ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js'
 = javascript_include_tag :application
 ```
 
-In your `app/assets/javascripts/application.js.coffee`:
+In `app/assets/javascripts/application.js.coffee`:
 
 ```coffee
 //= require googleplus.reader
 
-reader = new GooglePlus.Reader \
-  id: 'user_id', key: 'api_key'
+reader = new GooglePlus.Reader(id: 'user_id', key: 'api_key')
 
-reader.next 5, (posts) ->
-  console.log post for post in posts
+reader.next(5).done (posts) ->
+  console.log(post) for post in posts
 ```
 
 Here `user_id` is the identifier of a Google+ user, and `api_key` is your
@@ -56,11 +57,10 @@ A more interesting example with photos that a user publishes:
 ```coffee
 //= require googleplus.photoreader
 
-reader = new GooglePlus.PhotoReader \
-  id: 'user_id', key: 'api_key'
+reader = new GooglePlus.PhotoReader(id: 'user_id', key: 'api_key')
 
-reader.next 5, (photos) ->
-  console.log photo.attributes for photo in photos
+reader.next(5).done (photos) ->
+  console.log(photo.attributes) for photo in photos
 ```
 
 `photo` is an instance of `GooglePlus.Photo`. Right now, `attributes`
@@ -69,23 +69,19 @@ can be easily added via a pull request >:)~ The only method that `photo`
 has is `load`, which can be used as follows:
 
 ```coffee
-photo.load {}, (element) ->
-  $('#original').append element
-
-photo.load width: 300, (element) ->
-  $('#small').append element
+photo.load().done (element) ->
+  $('#original').append(element)
 
-photo.load width: 1000, (element) ->
-  $('#large').append element
+photo.load(width: 300).done (element) ->
+  $('#small').append(element)
 
-element = photo.load width: 2000
-console.log element.attr('href')
-$('#huge').append element
+photo.load(width: 1000).done (element) ->
+  $('#large').append(element)
 ```
 
-`load` constructs an URL referencing the photo of the desired size and
-preloads it using an `img` element, which it returns right away and also
-passes to the callback function once the photo has been loaded.
+`load` constructs an URL referencing the photo of the desired size and preloads
+it using an `img` element, which is passes to `done` once the photo has been
+loaded.
 
 ## Contributing
 

data/lib/assets/javascripts/googleplus.photo.js.coffee

@@ -1,33 +1,40 @@
 class Photo
   constructor: (@attributes) ->
+    @$ = jQuery
 
-  load: (options, callback) ->
-    options ||= {}
+  load: (options = {}) ->
+    deferred = @$.Deferred()
 
     width = options.width if options.width?
 
     if @attributes.width?
       if width?
-        width = Math.min width, @attributes.width
+        width = Math.min(width, @attributes.width)
       else
         width = @attributes.width
 
     if width?
-      width = Math.round width
-      url = @attributes.url.replace /w\d+-h\d+(-p)?/, "w#{ width }"
+      width = Math.round(width)
+      url = @attributes.url.replace(/w\d+-h\d+(-p)?/, "w#{width}")
     else
       url = @attributes.url
 
-    element = $('<img/>')
+    element = @$('<img/>')
 
-    if callback?
-      element.on 'load', ->
-        element.off 'load'
-        callback element
+    element
+      .on 'load', ->
+        element.off('load error')
+        deferred.resolve(element)
+        return
 
-    element.attr src: url
+      .on 'error', (details...) ->
+        element.off('load error')
+        deferred.reject(details...)
+        return
 
-    element
+    element.attr(src: url)
+
+    deferred.promise()
 
 window.GooglePlus ||= {}
 window.GooglePlus.Photo = Photo

data/lib/assets/javascripts/googleplus.reader.js.coffee

@@ -1,41 +1,49 @@
 class Reader
   constructor: (options) ->
+    @$ = jQuery
+
     @id = options.id
     @key = options.key
     @token = null
     @collection = []
     @position = 0
 
-  next: (count, callback) ->
+  next: (count) ->
+    deferred = @$.Deferred()
+
     nextPosition = @position + count
 
     if nextPosition <= @collection.length
-      callback @collection.slice(@position, nextPosition) if callback?
+      elements = @collection.slice(@position, nextPosition)
       @position = nextPosition
-      return
+      deferred.resolve(elements)
 
-    @load =>
-      nextPosition = Math.min nextPosition, @collection.length
-      callback @collection.slice(@position, nextPosition) if callback?
-      @position = nextPosition
-      return
+    else
+      @load()
+        .done =>
+          nextPosition = Math.min(nextPosition, @collection.length)
+          elements = @collection.slice(@position, nextPosition)
+          @position = nextPosition
+          deferred.resolve(elements)
+          return
 
-    return
+        .fail (details...) =>
+          deferred.reject(details...)
+          return
+
+    deferred.promise()
 
-  load: (callback) ->
-    url = "https://www.googleapis.com/plus/v1/people/#{ @id }/activities/public?key=#{ @key }"
-    url = "#{ url }&pageToken=#{ @token }" if @token
+  load: ->
+    url = "https://www.googleapis.com/plus/v1/people/#{@id}/activities/public?key=#{@key}"
+    url = "#{url}&pageToken=#{@token}" if @token
 
-    jQuery.ajax(url: url, crossDomain: true, dataType: 'jsonp').done (result) =>
-      @append result.items
+    @$.ajax(url: url, crossDomain: true, dataType: 'jsonp').done (result) =>
+      @append(result.items)
       @token = result.nextPageToken
-      callback() if callback?
       return
 
-    return
-
   append: (items) ->
-    @collection.push item for item in items
+    @collection.push(item) for item in items
     return
 
 window.GooglePlus ||= {}

data/lib/googleplus/reader/version.rb

@@ -1,5 +1,5 @@
 module GooglePlus
   module Reader
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: googleplus-reader
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ivan Ukhov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler