tagstand 0.0.1

data/.gitignore

@@ -0,0 +1,55 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# RVM generated
+.rvmrc
+
+*.gem
+Gemfile.lock
+.document
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+
+# For TextMate
+*.tmproj
+tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem 'hashie'
+gem 'httparty'
+gem 'json'
+
+group :development, :test do
+	gem 'fakeweb', '>= 1.3.0'
+	gem 'rspec', '>= 2.9.0'
+end

data/README.rdoc

@@ -0,0 +1,56 @@
+= Tagstand
+
+This gem is still under development. Use at your own risk.
+
+== Requirements
+
+You will need a {Tagstand API Key}[https://www.tagstand.com/signup] in order to get started.
+
+== Installation
+
+  (sudo) gem install tagstand
+
+== Usage
+
+Please refer to the {Tagstand API Documentation}[https://manage.tagstand.com/api/docs] for more information about the API, or follow the examples below:
+
+  require 'tagstand'
+  
+  Tagstand.api_key = ENV['TAGSTAND_API_KEY']
+  
+  tags = Tagstand::Tag.create
+ 	tag.created_at
+  tag.votes
+  
+  taps = Tagstand::Tap.list
+  taps.total_taps_count
+  taps.taps
+  
+  user = Tagstand::User.create('sample@email.com')
+  key = Tagstand::User.key('sample@email.com', 'password')
+
+And that's it!
+
+== Errors
+
+Errors are based on the HTTP response of the request, so that you can rescue accordingly:
+
+  rescue Tagstand::ClientError > req
+  rescue Tagstand::BadRequest > req
+  rescue Tagstand::NotFound > req
+  rescue Tagstand::Unauthorized > req
+
+== Contributing to Tagstand
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Tatemae Consultancy. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "bundler/version"
+require "rake/testtask"
+require "./lib/tagstand"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+desc "Build the gem"
+task :build do
+  system "gem build tagstand.gemspec"
+end
+
+desc "Build and release the gem"
+task :release => :build do
+  system "gem push tagstand-#{Tagstand::VERSION}.gem"
+end
+
+task :default => :test

data/lib/tagstand.rb

@@ -0,0 +1,97 @@
+require 'cgi'
+require 'uri'
+require 'httparty'
+require 'hashie'
+Hash.send :include, Hashie::HashExtensions
+
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'tagstand/version'
+require 'tagstand/tag'
+require 'tagstand/tap'
+require 'tagstand/user'
+
+module Tagstand
+  class << self
+    # Allow Tagstand.api_key = "..."
+    def api_key=(api_key)
+      Tagstand.api_key = api_key
+    end
+
+    def base_uri=(uri)
+      Tagstand.base_uri uri
+    end
+
+    # Allows the initializer to turn off actually communicating to the REST service for certain environments
+    # Requires fakeweb gem to be installed
+    def disable
+      FakeWeb.register_uri(:any, %r|#{Regexp.escape(Tagstand.base_uri)}|, :body => '{"Disabled":true}', :content_type => 'application/json; charset=utf-8')
+    end
+  end
+
+  # Represents a Tagstand API error and contains specific data about the error.
+  class TagstandError < StandardError
+    attr_reader :data
+    def initialize(data)
+      @data = Hashie::Mash.new(data)
+      super "The Tagstand API responded with the following error - #{data}"
+    end
+  end
+
+  class ClientError < StandardError; end
+  class ServerError < StandardError; end
+  class BadRequest < TagstandError; end
+  class Unauthorized < StandardError; end
+  class NotFound < ClientError; end
+  class Unavailable < StandardError; end
+
+  class Tagstand
+    include HTTParty
+
+    @@base_uri = "https://manage.tagstand.com/api/"
+    @@api_key = ""
+    headers({ 
+      'User-Agent' => "tagstand-gem-#{VERSION}",
+      'Content-Type' => 'application/json; charset=utf-8',
+      'Accept-Encoding' => 'gzip, deflate'
+    })
+    base_uri @@base_uri
+
+    class << self
+      # Get the API key
+      def api_key; @@api_key end
+      
+      # Set the API key
+      def api_key=(api_key)
+        return @@api_key unless api_key
+        @@api_key = api_key
+      end
+
+      # Get the Base URI.
+      def base_uri; @@base_uri end
+
+      def get(*args); handle_response super end
+      def post(*args); handle_response super end
+      def put(*args); handle_response super end
+      def delete(*args); handle_response super end
+
+      def handle_response(response) # :nodoc:
+        case response.code
+        when 400
+          raise BadRequest.new response.parsed_response
+        when 401
+          raise Unauthorized.new
+        when 404
+          raise NotFound.new
+        when 400...500
+          raise ClientError.new response.parsed_response
+        when 500...600
+          raise ServerError.new
+        else
+          response
+        end
+      end
+    end
+  end
+end

data/lib/tagstand/tag.rb

@@ -0,0 +1,64 @@
+require 'tagstand'
+require 'json'
+
+module Tagstand
+  # Represents a tag
+  class Tag
+    class << self
+      
+      # TODO: document this method
+      # TODO: POST body causing error
+      def create(tag=nil)
+        options = {query: {api_key: Tagstand.api_key}}
+        options.merge!(body: "tag=#{tag.to_json}") if tag
+        response = Tagstand.post "/tag_create", options
+        Hashie::Mash.new(response)
+      end
+      
+      # TODO: document this method
+      # id can be either a number (Int) or URL key (String)
+      def destroy(id)
+        query = {api_key: Tagstand.api_key}
+        ident = id.is_a?(Integer) ? {number: id} : {url_key: id}
+        query.merge!(ident)
+        options = {query: query}
+        response = Tagstand.get "/tag_destroy", options
+        Hashie::Mash.new(response)
+      end
+      
+      # TODO: document this method
+      # Args: order, name_prefix_filter, data_type_filter, number_filter, page, num_per_page
+      def list(args={})
+        options = {query: {api_key: Tagstand.api_key}}
+        options.merge!(args) unless args.empty?
+        response = Tagstand.get "/tag_list", options
+        Hashie::Mash.new(response)
+      end
+      
+      # TODO: document this method
+      # id can be either a number (Int) or URL key (String)
+      def show(id)
+        query = {api_key: Tagstand.api_key}
+        ident = id.is_a?(Integer) ? {number: id} : {url_key: id}
+        query.merge!(ident)
+        options = {query: query}
+        response = Tagstand.get "/tag_show", options
+        Hashie::Mash.new(response)
+      end
+      
+      # TODO: document this method
+      # id can be either a number (Int) or URL key (String)
+      # TODO: POST body causing error
+      def update(id, tag=nil)
+        query = {api_key: Tagstand.api_key}
+        ident = id.is_a?(Integer) ? {number: id} : {url_key: id}
+        query.merge!(ident)
+        options = {query: query}
+        options.merge!(body: "tag=#{tag.to_json}") if tag
+        response = Tagstand.post "/tag_update", options
+        Hashie::Mash.new(response)
+      end
+      
+    end
+  end
+end

data/lib/tagstand/tap.rb

@@ -0,0 +1,20 @@
+require 'tagstand'
+require 'json'
+
+module Tagstand
+  # Represents a tap
+  class Tap
+    class << self
+      
+      # TODO: document this method
+      # Args: order, tag_name_prefix_filter, tag_data_type_filter, tag_number_filter, page, num_per_page
+      def list(args={})
+        options = {query: {api_key: Tagstand.api_key}}
+        options.merge!(args) unless args.empty?
+        response = Tagstand.get "/tap_list", options
+        Hashie::Mash.new(response)
+      end
+      
+    end
+  end
+end

data/lib/tagstand/user.rb

@@ -0,0 +1,29 @@
+require 'tagstand'
+require 'json'
+
+module Tagstand
+  # Represents a user
+  class User
+    class << self
+      
+      # TODO: document this method
+      # TODO: POST body causing error
+      def create(email, pwd=nil)
+        options = {query: {api_key: Tagstand.api_key}}
+        user = {email: email}
+        user.merge!(password: pwd) if pwd
+        options.merge!(body: "user=#{user.to_json}")
+        response = Tagstand.post "/user_create", options
+        Hashie::Mash.new(response)
+      end
+      
+      # TODO: document this method
+      def key(email, pwd)
+        options = {query: {api_key: Tagstand.api_key, email: email, password: pwd}}
+        response = Tagstand.get "/user_key", options
+        Hashie::Mash.new(response)
+      end
+      
+    end
+  end
+end

data/lib/tagstand/version.rb

@@ -0,0 +1,3 @@
+module Tagstand
+  VERSION = "0.0.1" unless defined?(Tagstand::VERSION)
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'tagstand'

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'fakeweb'
+require 'tagstand'
+
+FakeWeb.allow_net_connect = false
+
+RSpec.configure do |config|
+  config.before(:each) do
+    FakeWeb.clean_registry
+    Tagstand.api_key = '123abc456def789ghi'
+  end
+end

data/spec/tagstand/fixtures/tag.json

@@ -0,0 +1,18 @@
+{
+	"created_at":"2012-05-22T17:19:14Z",
+	"custom":true,
+	"data":"hi",
+	"data_type":"text",
+	"deleted":null,
+	"id":44258,
+	"name":"first",
+	"num_checkins":0,
+	"number":37,
+	"pass_uuid_param":null,
+	"sign_url":null,
+	"source":"api",
+	"updated_at":"2012-05-22T17:19:14Z",
+	"url_key":"vbd4du",
+	"user_id":4,
+	"votes":0
+}

data/tagstand.gemspec

@@ -0,0 +1,27 @@
+require 'bundler'
+require 'bundler/version'
+
+require File.expand_path('lib/tagstand/version')
+
+Gem::Specification.new do |s|
+  s.add_runtime_dependency('hashie')
+  s.add_runtime_dependency('httparty')
+  s.add_runtime_dependency('json')
+  s.add_development_dependency('fakeweb')
+  s.add_development_dependency('rspec')
+  s.name = "tagstand"
+  s.authors = ["Brian Getting"]
+  s.description = %q{Implements the complete functionality of the Tagstand Tag Manager API beta (v0.2).}
+  s.email = ["brian@tatem.ae"]
+  s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = "http://github.com/tatemae-consultancy/tagstand"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.summary = %q{A library which implements the complete functionality of the Tagstand Tag Manager API beta (v0.2).}
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Tagstand::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: tagstand
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Getting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Implements the complete functionality of the Tagstand Tag Manager API
+  beta (v0.2).
+email:
+- brian@tatem.ae
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/tagstand.rb
+- lib/tagstand/tag.rb
+- lib/tagstand/tap.rb
+- lib/tagstand/user.rb
+- lib/tagstand/version.rb
+- rails/init.rb
+- spec/spec_helper.rb
+- spec/tagstand/fixtures/tag.json
+- tagstand.gemspec
+homepage: http://github.com/tatemae-consultancy/tagstand
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A library which implements the complete functionality of the Tagstand Tag
+  Manager API beta (v0.2).
+test_files:
+- spec/spec_helper.rb
+- spec/tagstand/fixtures/tag.json