serpscan 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64caaa4a34f1602e0b168432424a23c478690cb4
-  data.tar.gz: 3aabf4b7e02237d19c6d7b0b0db874127926d7b2
+  metadata.gz: 412ac7c48836fef8fea3d7e290dead4210469d71
+  data.tar.gz: 7e242920660cbe89d0c75dd230070683129e0dfc
 SHA512:
-  metadata.gz: c1d9363fb73c62fd135ed7cecc72f14cc1078b9bece1e34870c67f4f8533632e5f83b5a2d66e5aefcf4b119e22ed2c723e01eb6f3f50bd52f0771b7151346e40
-  data.tar.gz: ad6ac3820209b650dec2b08fa9a03de5e8b9b14928200322c910136be6ebbb62e3a2590961c57e9a26fb6fc1217edc2d9b4dddb2e388afb146b3f0434f33de8a
+  metadata.gz: bbd2c2a7c46b2b3483b198bbc80a819c259e01998ea11c45d0b53f977382a9e5639677e61cf03a4f45af6df496a60dac5432ffa7877af6c57cca5e7da34ec17d
+  data.tar.gz: e512e1db694a02f04ff4bcc9f6d7aa1288e01f515159746ad5f8c6f660941834563ac61e65205d2f6c30bd6e8d9f822dc2ed6617166b6bb3b46a3078eb5c4656

data/README.md

@@ -28,6 +28,12 @@ Set your API key. If you're using Rails you may want to place the code below in
 Serpscan.api_key = 'YOUR API KEY'
 ```
 
+Alternatively you can set your API key as an environment variable:
+
+```ruby
+ENV['SERPSCAN_API_KEY'] = 'YOUR API KEY'
+```
+### Websites
 To create a website:
 
 ```ruby
@@ -54,6 +60,7 @@ website = Serpscan::Website.find(1)
 website.keywords
 ```
 
+### Keywords
 To create a keyword:
 
 ```ruby
@@ -61,6 +68,15 @@ website = Serpscan::Website.find(1)
 website.create_keyword('example keyword')
 ```
 
+To get a particular keyword:
+```ruby
+Serpscan::Keyword.find(id)
+```
+
+Ranking history:
+```ruby
+Serpscan::Keyword.find(id).history #> [['2015-01-01', 2], ['2015-01-02', 1]]
+```
 ## Attributes
 
 Each of these attributes can be called directly on the object. Example:

data/lib/serpscan/keyword.rb

@@ -7,5 +7,9 @@ module Serpscan
     def website
       parent
     end
+
+    def history
+      @history ||= Serpscan::API.get("#{api_path}/#{id}/history")['rankings']
+    end
   end
 end

data/lib/serpscan/version.rb

@@ -1,3 +1,3 @@
 module Serpscan
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/spec/lib/serpscan/keyword_spec.rb

@@ -2,7 +2,18 @@ require 'spec_helper'
 
 describe Serpscan::Keyword, vcr: true do
   it_should_behave_like 'a creatable object',      keyword: 'example keyword', website_id: 1, search_engine_country_id: 1
-
   it_should_behave_like 'a findable object',  1, Serpscan::Keyword::ATTRIBUTES
   it_should_behave_like 'a deletable object', 2
+
+  describe 'history' do
+    it 'should return an array of dates and rankings' do
+      keyword = subject.class.find(1)
+      history = keyword.history
+
+      expect(history.class).to eq Array
+      expect(history.first.class).to eq Array
+      expect(history.first[0].class).to eq String
+      expect(history.first[1].class).to eq Fixnum
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serpscan
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Dylan Montgomery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-17 00:00:00.000000000 Z
+date: 2015-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler