kippt 0.0.4 → 1.0.0

data/lib/kippt/clips.rb

@@ -5,11 +5,16 @@ require "kippt/clip"
 
 class Kippt::Clips
   include Kippt::CollectionResource
+  VALID_SEARCH_PARAMETERS = [:q, :list, :is_starred]
 
   def initialize(client)
     @client = client
   end
 
+  def self.valid_filter_parameters
+    [:limit, :offset, :is_read_later, :is_starred]
+  end
+
   def object_class
     Kippt::Clip
   end
@@ -23,15 +28,24 @@ class Kippt::Clips
   end
 
   def search(parameters)
-    # TODO: Validate parameters
     if parameters.is_a?(String)
       Kippt::ClipCollection.new(
         @client.get("search/clips", {:q => parameters}).body,
         self)
     else
+      validate_search_parameters(parameters)
+
       Kippt::ClipCollection.new(
         @client.get("search/clips", parameters).body,
         self)
     end
   end
+
+  private
+
+  def validate_search_parameters(parameters)
+    parameters.each do |key, value|
+      raise ArgumentError.new("'#{key}' is not a valid search parameter") unless VALID_SEARCH_PARAMETERS.include?(key)
+    end
+  end
 end

data/lib/kippt/collection_resource.rb

@@ -43,7 +43,7 @@ module Kippt::CollectionResource
 
   def validate_collection_options(options)
     options.each do |key, _|
-      unless [:limit, :offset].include?(key)
+      unless self.class.valid_filter_parameters.include?(key)
         raise ArgumentError.new("Unrecognized argument: #{key}")
       end
     end

data/lib/kippt/lists.rb

@@ -10,6 +10,10 @@ class Kippt::Lists
     @client = client
   end
 
+  def self.valid_filter_parameters
+    [:limit, :offset]
+  end
+
   def object_class
     Kippt::List
   end

data/lib/kippt/version.rb

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

data/spec/kippt/client_spec.rb

@@ -6,7 +6,7 @@ describe Kippt::Client do
     context "when there is no username" do
       it "raises error" do
         lambda {
-          Kippt::Client.new(password: "secret")
+          Kippt::Client.new(:password => "secret")
         }.should raise_error(ArgumentError, "username is required")
       end
     end
@@ -14,7 +14,7 @@ describe Kippt::Client do
     context "when there is no password or token" do
       it "raises error" do
         lambda {
-          Kippt::Client.new(username: "vesan")
+          Kippt::Client.new(:username => "vesan")
         }.should raise_error(ArgumentError, "password or token is required")
       end
     end
@@ -50,7 +50,7 @@ describe Kippt::Client do
 
     it "returns a Kippt::Account instance" do
       subject.should_receive(:get).with("account").and_return(
-        stub body: {}
+        stub :body => {}
       )
       account = subject.account
       account.should be_a(Kippt::Account)

data/spec/kippt/clips_spec.rb

@@ -14,16 +14,30 @@ describe Kippt::Clips do
     subject { Kippt::Client.new(valid_user_credentials).clips }
 
     describe "parameters" do
-      it "accepts String" do
-        stub_get("/search/clips?q=bunny").
-          to_return(:status => 200, :body => fixture("clips.json"))
-        subject.search("bunny")
+      context "when parameter is a String" do
+        it "does the search with the string being q" do
+          stub_get("/search/clips?q=bunny").
+            to_return(:status => 200, :body => fixture("clips.json"))
+          subject.search("bunny")
+        end
       end
 
-      it "accepts Hash" do
-        stub_get("/search/clips?q=bunny&list=4&is_starred=true").
-          to_return(:status => 200, :body => fixture("clips.json"))
-        subject.search(:q => "bunny", :list => 4, :is_starred => true)
+      context "when parameter is a Hash" do
+        context "with accepted keys" do
+          it "does the search" do
+            stub_get("/search/clips?q=bunny&list=4&is_starred=true").
+              to_return(:status => 200, :body => fixture("clips.json"))
+            subject.search(:q => "bunny", :list => 4, :is_starred => true)
+          end
+        end
+
+        context "with invalid keys" do
+          it "raises ArgumentError" do
+            lambda {
+              subject.search(:q => "bunny", :stuff => true)
+            }.should raise_error(ArgumentError, "'stuff' is not a valid search parameter")
+          end
+        end
       end
     end
 

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
-require "simplecov"
-SimpleCov.start
+unless ENV["CI"] == "true"
+  require "simplecov"
+  SimpleCov.start
+end
 
 require "kippt"
 require "rspec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kippt
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors: