streak-ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    M2RiZmU2ZGRmNmRhZTNiOTU1NmI0MzY2MjM1M2ZjMWIyYTE1N2NhMg==
+    YzZhMDMwYTUyZmNmMGE1ZGIxMjI0NTIyYmM1Yjk3Njc1YjY0NmQ3ZA==
   data.tar.gz: !binary |-
-    Yzc3MTRmYjlkZjk1YTQyYjFjZTVlY2FlYTY4OWI0MThmYjQxZGUzOQ==
+    ZDI5NDg3YTE3ZTY5NDgxYjliMTljMjY0Mjg2ODJmYWRmNzNkM2QwNQ==
 SHA512:
   metadata.gz: !binary |-
-    MTRkOGIzNDE4MWY5MzE2YzI5MzA4ODY1ZDk4ZDU1NjkxNDBhYzcxZDI1MjUw
-    MGEzN2E4YzUxZWE0MTZlODhjOTk3YzliMDNmMzFiMmZlMmQwMjE5MzQ4YzU4
-    ODdjYTE5ZDU1MDc1OGI5OTYyOGU4NGJmZWUzMzk5MzFhYjlkM2M=
+    MzBjZGI2NzRlNTZjN2IzYWE4OWQ3NThkMTA0MTIyMDM1Y2I3MjZkYTNkMDE1
+    ZGMzZmY1MmNhOGZiODkxODY1OTZhZTM5OTYzY2QxMmFiYzhhMjk1MjY1MjNj
+    YTdmMjExNjhhOTE5ZjZjZWM5ODc3MmQ0NTE2NGE2YTA5MjFhNWU=
   data.tar.gz: !binary |-
-    YzJhNDE0YjBhZDYwYWY1OGU0ZWQ3YWIxNTUxOTQxZDI1ODZiMGUzOTYwZjQ5
-    NmQxMjExOWYxMmNjODE1NmQ5MDRkYmVmYjAxYTBmNzI2NDkzN2FkNjdlNDQy
-    MTExYzAyZjY0NGIxMGM1N2I0YTljNTFlZTI4YWZiN2FlNjYzMjE=
+    YjE0OTA2MjIxOGQwNzQ5NTExYjFjYmVmN2VmNDIwZTY5NjlkOTdkMzIwMTEy
+    MjY4YWZjZTdiOTY3ZmY5NjJhNTNiZmZiODhmYTE4YTdkOTUyMzM2YTgxNDdh
+    NTI3MmZkNjBkNTVlOThkZGQ3OGYzNTlhY2M0Njc2N2E0YzEzYWM=

data/README.md

@@ -1,12 +1,12 @@
 # Streak
 
-TODO: Write a gem description
+Ruby bindings for the Streak API [www.streak.com/api/](http://www.streak.com/api/). Streak is a CRM in your Gmail inbox.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'streak'
+    gem 'streak-ruby'
 
 And then execute:
 
@@ -14,11 +14,47 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install streak
+    $ gem install streak-ruby
 
 ## Usage
 
-TODO: Write usage instructions here
+Configure your api key:
+
+    Streak.api_key = '7941e92da6247ab955aab91ec479a4a2'
+
+Retrieve all pipelines:
+
+    Streak::Pipeline.all
+
+Retrieve one pipeline:
+
+    Streak::Pipeline.find(pipeline_key)
+
+Create a box:
+
+    Streak::Box.create(pipeline_key, { :name => 'My customer' })
+
+Update the value of box field:
+
+    Streak::FieldValue.update(box_key, field_key, :value => value)
+
+See the complete Streak API reference here: [http://www.streak.com/api/](http://www.streak.com/api/)
+
+This gem currently supports:
+
+* User
+* Pipelines
+* Boxes
+* Stages
+* Fields
+* Reminders (TODO)
+* Files (TODO)
+* Threads (TODO)
+* Comments (TODO)
+* Snippets (TODO)
+* Search (TODO)
+* Newsfeed (TODO)
+
 
 ## Contributing
 

data/lib/streak.rb

@@ -13,6 +13,8 @@ require "streak/field_value"
 require "streak/pipeline"
 require "streak/stage"
 require "streak/user"
+require "streak/search"
+require "streak/file"
 
 module Streak
   @api_base = "https://www.streak.com/api/v1"

data/lib/streak/box.rb

@@ -1,8 +1,8 @@
 module Streak
   class Box < StreakObject
-    def self.all(pipeline_key=nil)
+    def self.all(pipeline_key=nil, params={})
       path = pipeline_key ? "/pipelines/#{pipeline_key}/boxes" : "/boxes"
-      res = Streak.request(:get, path)
+      res = Streak.request(:get, path, params)
       convert_to_streak_object(res, Box)
     end
 
@@ -22,4 +22,3 @@ module Streak
     end
   end
 end
-

data/lib/streak/file.rb

@@ -0,0 +1,13 @@
+module Streak
+  class File < StreakObject
+    def self.all(box_key)
+      res = Streak.request(:get, "/boxes/#{box_key}/files")
+      convert_to_streak_object(res, File)
+    end
+
+    def self.get_link(file_key)
+      res = Streak.request(:get, "/files/#{file_key}/link")
+      convert_to_streak_object(res, File)
+    end
+  end
+end

data/lib/streak/search.rb

@@ -0,0 +1,8 @@
+module Streak
+  class Search < StreakObject
+    def self.query(s_query)
+      res = Streak.request(:get, "/search", {query: s_query})
+      convert_to_streak_object(res, Search)
+    end
+  end
+end

data/lib/streak/version.rb

@@ -1,3 +1,3 @@
 module Streak
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/spec_helper.rb

@@ -164,4 +164,3 @@ def test_user(params={})
     "key" => "agptYWlsZm9vZ2FlciYLEgxPcmdhbml6YXRpb24iCnN0cmVhay5jb20MCxIEVXNlchgBDA"
   }.merge(params)
 end
-

data/spec/streak/file_spec.rb

@@ -0,0 +1,25 @@
+describe Streak::File do
+  let!(:api) { Streak.mock_rest_client = double('RestClient') }
+  let(:box) { test_box }
+
+  describe ".all" do
+    it "should call the api" do
+      api.should_receive(:get).
+        with(Streak.api_url("/boxes/box_key_1/files"), nil, nil).
+        and_return(test_response(box))
+
+      Streak::File.all("box_key_1")
+    end
+  end
+
+  describe ".get_link" do
+    it "should call the api" do
+      api.should_receive(:get).
+        with(Streak.api_url("/files/box_key_1/link"), nil, nil).
+        and_return(test_response(box))
+
+      Streak::File.get_link("box_key_1")
+    end
+  end
+
+end

data/spec/streak/search_spec.rb

@@ -0,0 +1,15 @@
+describe Streak::Search do
+  let!(:api) { Streak.mock_rest_client = double('RestClient') }
+  let(:box) { test_box }
+
+  describe ".search" do
+    it "should call the api" do
+      api.should_receive(:get).
+        with(Streak.api_url("/search?query=box_key_1"), nil, nil).
+        and_return(test_response(box))
+
+      Streak::Search.query("box_key_1")
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: streak-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - JS Boulanger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -100,7 +100,9 @@ files:
 - lib/streak/box.rb
 - lib/streak/field.rb
 - lib/streak/field_value.rb
+- lib/streak/file.rb
 - lib/streak/pipeline.rb
+- lib/streak/search.rb
 - lib/streak/stage.rb
 - lib/streak/streak_error.rb
 - lib/streak/streak_object.rb
@@ -111,7 +113,9 @@ files:
 - spec/streak/box_spec.rb
 - spec/streak/field_spec.rb
 - spec/streak/field_value_spec.rb
+- spec/streak/file_spec.rb
 - spec/streak/pipeline_spec.rb
+- spec/streak/search_spec.rb
 - spec/streak/stage_spec.rb
 - spec/streak/streak_object_spec.rb
 - spec/streak/user_spec.rb
@@ -145,7 +149,9 @@ test_files:
 - spec/streak/box_spec.rb
 - spec/streak/field_spec.rb
 - spec/streak/field_value_spec.rb
+- spec/streak/file_spec.rb
 - spec/streak/pipeline_spec.rb
+- spec/streak/search_spec.rb
 - spec/streak/stage_spec.rb
 - spec/streak/streak_object_spec.rb
 - spec/streak/user_spec.rb