brandspotter 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01ba22ee63e79e02d6518f1b203f42b1d1c19977
-  data.tar.gz: 0a934487301b64e3239146bf8ca7af58d4fe5b2f
+  metadata.gz: 71a7612b26d3403b8ec7f271850d8893ad981af7
+  data.tar.gz: 8371df6a3edfd721bc1744432e598a6ad6bfd3cd
 SHA512:
-  metadata.gz: 701321abe62ce7b3c853cc97a3ef0e2c7836578e7ae3c509371f79c687dd118294438ac1c4f0762214964b7854981d20eca3e9e24b71456c15ba8ad85f075931
-  data.tar.gz: ad0e7743f14ab4c08b8c92cc9476bcfacb97aabe723e5497dfbcd1e5dd5a025aa89e8ba543f7e00efd7c676765b7232533257f2db2aa3b87079f7dcaaaaad254
+  metadata.gz: 4b826af70df03199ec8024bfea35a21ce6345765739a5eb267ecba28ee62fbe17c5a6363593f8fcc945711f48dc4371ec53e960a2c1a7821bfd4c1fb759a0002
+  data.tar.gz: ddb08fac5157f0fd3469529a250f2f8a6a47a9f2cbe3d8ae6a36ee4ce0cf2873dbcef8363291d101460a6832730e325e0b4d21b2375e062dea91aa1955664ca7

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store

data/README.md

@@ -1,16 +1,13 @@
 # Brandspotter
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/brandspotter`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Sign up for your api credentials at: http://brandspotter.herokuapp.com
+API is currently invitation only.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'brandspotter'
-```
+    gem ‘brandspotter’, '~> 0.1.0'
 
 And then execute:
 
@@ -21,16 +18,27 @@ Or install it yourself as:
     $ gem install brandspotter
 
 ## Usage
+Create a new initializer: (config/initializers/brandspotter.rb)
 
-TODO: Write usage instructions here
+    Brandspotter.configure do |config|
+      config.user_token = ENV[‘brandspotter_user_token’]
+    end
 
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Methods
+    # create a new subscription
+    client = Brandspotter::Client.new
+    client.create_subscription(hashtag: 'hashtag')
 
-## Contributing
+    # list all subscriptions
+    client = Brandspotter::Client.new
+    client.subscriptions
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/brandspotter.
+    # find specific subscription
+    client = Brandspotter::Client.new
+    client.find_subscription(subscription_id)
 
+    # delete subscription
+    client = Brandspotter::Client.new
+    client.destroy_subscription(subscription_id)

data/lib/brandspotter/client.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../client/endpoints.rb', __FILE__)
+require File.expand_path('../client/jobs.rb', __FILE__)
+
+module Brandspotter
+  class Client
+	  attr_accessor :user_token
+
+		def initialize
+		  @user_token = Brandspotter.configuration.user_token
+		end
+  end
+end

data/lib/brandspotter/client/endpoints.rb

@@ -0,0 +1,23 @@
+module Brandspotter
+  class Client
+	  def base_uri(path='/')
+		  "http://brandspotter.herokuapp.com/api#{path}?user_token=#{self.user_token}&"
+		end
+
+		def configure_payload(path, opts={})
+		  base_uri(path) + opts.to_params
+		end
+
+		def get_request(url)
+			JSON.parse RestClient::Request.execute(method: :get, url: url)
+		end
+
+    def post_request(path, opts)
+      JSON.parse RestClient.post(base_uri(path), opts)
+    end
+
+    def delete_request(path)
+      JSON.parse RestClient::Request.execute(method: :delete, url: base_uri(path))
+    end
+	end
+end

data/lib/brandspotter/client/jobs.rb

@@ -0,0 +1,21 @@
+module Brandspotter
+  class Client
+
+    def subscriptions
+      get_request configure_payload('/subscriptions')
+    end
+
+    def find_subscription(id)
+      get_request configure_payload("/subscriptions/#{id}")
+    end
+
+    def create_subscription(opts={})
+      opts.assert_valid_keys(:hashtag)
+      post_request '/subscriptions', opts
+    end
+
+    def destroy_subscription(id)
+      delete_request "/subscriptions/#{id}"
+    end
+  end
+end

data/lib/brandspotter/version.rb

@@ -1,3 +1,3 @@
 module Brandspotter
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/misc/hash.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../object', __FILE__)
+
+class Hash
+  def assert_valid_keys(*valid_keys)
+    valid_keys.flatten!
+    each_key {|k| raise(ArgumentError, "Unknown key #{k}") unless valid_keys.include?(k)}
+  end
+
+  def to_params
+    collect{|k, v| v.to_query(k)}.sort * '&'
+  end
+end

data/lib/misc/object.rb

@@ -0,0 +1,10 @@
+class Object
+  def to_param
+    to_s
+  end
+
+  def to_query(key)
+    require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+    "#{CGI.escape(key.to_s).gsub(/%(5B|5D)/n) { [$1].pack('H*') }}=#{CGI.escape(to_param.to_s)}"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brandspotter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Dirk van Wensem
@@ -68,7 +68,12 @@ files:
 - bin/setup
 - brandspotter.gemspec
 - lib/brandspotter.rb
+- lib/brandspotter/client.rb
+- lib/brandspotter/client/endpoints.rb
+- lib/brandspotter/client/jobs.rb
 - lib/brandspotter/version.rb
+- lib/misc/hash.rb
+- lib/misc/object.rb
 homepage: http://github.com/dennisdevulder/brandspotter
 licenses: []
 metadata: {}
@@ -88,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Implementation of the brandspotter API