kippt 1.0.0 → 1.1.0

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 1.1 / July 20, 2012
+
+Changes in response to feedback from [Matias Korhonen](https://github.com/k33l0r):
+
+* When adding new lists/clips the object is updated with data received from the service
+* Collections of lists & clips are Enumberable
+
+## 1.0 / June 17, 2012
+
+Initial official release.

data/README.md

@@ -73,7 +73,7 @@ Get all the lists:
 
 ```ruby
 client = Kippt::Client.new(username: "vesan", token: "2544d6bfddf5893ec8617")
-lists = client.lists # Returns Kippt::ListCollection
+lists = client.lists.all # Returns Kippt::ListCollection
 ```
 
 Get single list:
@@ -89,9 +89,11 @@ list = client.lists[list_id] # Returns Kippt::ListItem
 
 ```ruby
 client = Kippt::Client.new(username: "vesan", token: "2544d6bfddf5893ec8617")
-clips = client.clips # Returns Kippt::ClipCollection
+clips = client.clips.all # Returns Kippt::ClipCollection
 ```
 
+Both ListCollection and ClipCollection are Enumerable.
+
 
 ### Pagination
 

data/lib/kippt/clip.rb

@@ -2,7 +2,7 @@ require "ostruct"
 require "kippt/resource"
 
 class Kippt::Clip
-  include Resource
+  include Kippt::Resource
 
   attributes :url_domain, :updated, :is_starred, :title,
              :url, :notes, :created, :list, :id, :resource_uri

data/lib/kippt/collection.rb

@@ -1,4 +1,6 @@
 module Kippt::Collection
+  include Enumerable
+
   attr_reader :total_count, :limit, :offset
 
   def initialize(data, collection_resource = nil)

data/lib/kippt/collection_resource.rb

@@ -5,14 +5,16 @@ module Kippt::CollectionResource
     collection_class.new(@client.get(base_uri, options).body, self)
   end
 
-  def build
-    object_class.new({}, self)
+  def build(attributes = {})
+    object_class.new(attributes, self)
   end
 
   def [](resource_id)
     object_class.new(@client.get("#{base_uri}/#{resource_id}").body)
   end
 
+  alias find []
+
   def collection_from_url(url)
     raise ArgumentError.new("The parameter URL can't be blank") if url.nil? || url == ""
 
@@ -27,9 +29,11 @@ module Kippt::CollectionResource
     end
 
     save_response = {:success => response.success?}
+    save_response[:resource] = response.body
     if response.body["message"]
       save_response[:error_message] = response.body["message"]
     end
+
     save_response
   end
 

data/lib/kippt/list.rb

@@ -1,7 +1,7 @@
 require "ostruct"
 
 class Kippt::List
-  include Resource
+  include Kippt::Resource
 
   attributes :id, :rss_url, :updated, :title,
              :created, :slug, :resource_uri

data/lib/kippt/resource.rb

@@ -1,26 +1,27 @@
-module Resource
+module Kippt::Resource
   def self.included(base)
     base.instance_eval do
       extend Forwardable
       attr_reader :attributes, :errors
 
-      def_delegators "self.class", :writable_attribute_names
+      def_delegators "self.class", :writable_attribute_names, :attribute_names
     end
 
     base.extend(ClassMethods)
   end
 
   module ClassMethods
-    attr_reader :writable_attribute_names
+    attr_reader :writable_attribute_names, :attribute_names
 
     def attributes(*attribs)
-      def_delegators :attributes, *attribs
+      @attribute_names = attribs.map {|attrib| attrib.to_sym }
+      def_delegators :attributes, *@attribute_names
     end
 
     def writable_attributes(*attribs)
-      @writable_attribute_names = attribs
+      @writable_attribute_names = attribs.map {|attrib| attrib.to_sym }
       @writable_attribute_names.freeze
-      def_delegators :attributes, *(attribs.map {|attrib| attrib.to_s + "=" })
+      def_delegators :attributes, *(@writable_attribute_names.map {|attrib| attrib.to_s + "=" })
     end
   end
 
@@ -49,6 +50,13 @@ module Resource
     response = @collection_resource.save_resource(self)
     if response[:error_message]
       errors << response[:error_message]
+    else
+      if response[:resource]
+        updated_attributes = response[:resource].select do |key, _|
+          attribute_names.include?(key.to_sym)
+        end
+        @attributes = OpenStruct.new(updated_attributes)
+      end
     end
     response[:success]
   end

data/lib/kippt/version.rb

@@ -1,3 +1,3 @@
 module Kippt
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/spec_helper.rb

@@ -63,6 +63,12 @@ shared_examples_for "collection resource" do
     end
   end
 
+  describe "#find" do
+    it "exists" do
+      subject.respond_to?(:find).should be_true
+    end
+  end
+
   describe "#collection_from_url" do
     it "returns a new collection" do
       stub_get("/#{base_uri}/?limit=20&offset=20").
@@ -87,10 +93,19 @@ shared_examples_for "collection resource" do
     it "returns new resource" do
       subject.build.should be_a(resource_class)
     end
+
+    it "accepts parameters" do
+      subject.object_class.should_receive(:new).with({:an => "attribute"}, subject)
+      subject.build(:an => "attribute")
+    end
   end
 end
 
 shared_examples_for "collection" do
+  it "is Enumberable" do
+    subject.should be_a(Enumerable)
+  end
+
   describe "#total_count" do
     it "returns total count of resources" do
       subject.total_count.should eq data["meta"]["total_count"]
@@ -234,6 +249,13 @@ shared_examples_for "resource" do
           {:success => true})
         subject.save.should be_true
       end
+
+      it "sets the updated attributes received from the server" do
+        collection_resource.stub(:save_resource).and_return(
+          {:success => true, :resource => {:id => 9999}})
+        subject.save
+        subject.id.should eq 9999
+      end
     end
 
     context "with invalid parameters" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kippt
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-17 00:00:00.000000000 Z
+date: 2012-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70143540468320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,15 +21,10 @@ dependencies:
         version: 0.7.6
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.6
+  version_requirements: *70143540468320
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70143540467520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -37,15 +32,10 @@ dependencies:
         version: 0.8.7
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.7
+  version_requirements: *70143540467520
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70143540466360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -53,15 +43,10 @@ dependencies:
         version: 1.3.4
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.3.4
+  version_requirements: *70143540466360
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70143540465780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -69,15 +54,10 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.9.0
+  version_requirements: *70143540465780
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70143540465120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -85,15 +65,10 @@ dependencies:
         version: 1.8.6
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.6
+  version_requirements: *70143540465120
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70143540463960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,12 +76,7 @@ dependencies:
         version: 0.6.4
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.4
+  version_requirements: *70143540463960
 description: Client library for using Kippt.com API
 email:
 - vesa@vesavanska.com
@@ -117,6 +87,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -172,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Client library for using Kippt.com API