mashery 0.0.9

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+pkg

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+gem 'thor'
+gem 'httparty'
+gem 'activesupport'
+gem 'json'

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2010 Outside.in
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.textile

@@ -0,0 +1,27 @@
+A Ruby library for the "Mashery API":http://support.mashery.com/docs/mashery_api.
+
+h2. Prerequisites
+
+Install the gem dependencies (see "gembundler.com":http://gembundler.com/ if you aren't familiar with Bundler):
+
+@$ bundle install@
+
+h2. Calling methods from the command line
+
+A set of Thor tasks are provided so that you can call API methods from the command line (read more about Thor at
+"http://github.com/wycats/thor":http://github.com/wycats/thor).
+
+The following examples assume you have Thor installed system-wide. If it's local to your bundle, then replace
+@thor@ with @bundle exec thor@.
+
+You can see all available Mashery tasks with this command:
+
+@$ thor list mashery@
+
+h3. Environment
+
+Before you can successfully call an API method, you must set these environment variables:
+
+bc. $ export MASHERY_SITE_ID=666
+$ export MASHERY_API_KEY=cafebebedeadbeefcafebebedeadbeef
+$ export MASHERY_SHARED_SECRET=blahblahblah

data/Rakefile

@@ -0,0 +1,12 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "mashery"
+    gemspec.summary = "A Ruby library for the Mashery API"
+    gemspec.email = "brian@outside.in"
+    gemspec.homepage = "http://github.com/outsidein/mashery-rb"
+    gemspec.authors = ["Brian Moseley"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.9

data/lib/mashery.rb

@@ -0,0 +1,18 @@
+require 'mashery/exceptions'
+require 'mashery/client'
+require 'mashery/api_object_base'
+require 'mashery/member'
+require 'mashery/key'
+require 'mashery/role'
+
+module Mashery
+  mattr_accessor :client
+  @@client = nil
+
+  mattr_accessor :logger, :instance_writer => false
+  @@logger = Logger.new(STDOUT)
+  @@logger.level = Logger::WARN
+
+  mattr_accessor :test_mode, :instance_writer => false
+  @@test_mode = true
+end

data/lib/mashery/api_object_base.rb

@@ -0,0 +1,26 @@
+module Mashery
+  class ApiObjectBase
+    def self.create(fields = {})
+      # XXX: only send fields that aren't read-only
+      new(Mashery.client.call_remote(method('create'), fields))
+    end
+
+    def self.fetch(id)
+      data = Mashery.client.call_remote(method('fetch'), id)
+      data.nil?? nil : new(data)
+    end
+
+    def self.delete(id)
+      Mashery.client.call_remote(method('delete'), id)
+    end
+
+    def self.method(basename)
+      "#{name.split(/\:\:/).last.downcase}.#{basename}"
+    end
+
+    def initialize(data)
+      # XXX: use setter methods
+      data.each_pair {|k, v| instance_variable_set("@#{k}".to_sym, v)}
+    end
+  end
+end

data/lib/mashery/client.rb

@@ -0,0 +1,37 @@
+require 'active_support'
+require 'json'
+require 'httparty'
+require 'md5'
+
+module Mashery
+  class Client
+    TEST_HOST = 'api.sandbox.mashery.com'
+    PRODUCTION_HOST= 'api.mashery.com'
+
+    def initialize(site_id, key, secret)
+      host = Mashery.test_mode ? TEST_HOST : PRODUCTION_HOST
+      @uri = "http://#{host}/v2/json-rpc/#{site_id}"
+      @key = key
+      @secret = secret
+    end
+
+    def echo(value)
+      call_remote('test.echo', value)
+    end
+
+    def call_remote(method, *params)
+      # all calls are synchronous, so id in request and response will always be 1
+      Mashery.logger.debug("Calling method #{method} with params #{params.inspect}") if Mashery.logger
+      req = ::JSON[{:version => '1.1', :method => method, :params => params, :id => 1}]
+      response = HTTParty.post(signed_uri, :body => req)
+      res = ::JSON[response.body]
+      raise Exception.create(res['error']) if res.include?('error')
+      res['result']
+    end
+
+  protected
+    def signed_uri
+      "#{@uri}?apikey=#{@key}&sig=#{MD5.new(@key + @secret + Time.now.to_i.to_s).hexdigest}"
+    end
+  end
+end

data/lib/mashery/exceptions.rb

@@ -0,0 +1,24 @@
+module Mashery
+  class Exception < ::Exception
+    def self.create(options = {})
+      case options['code']
+      when 1000 then ValidationException.new(options['data'])
+      when 1001 then DuplicateObjectException.new("#{options['message']} (JSON-RPC error #{options['code']})")
+      else JsonRpcException.new("#{options['message']} (JSON-RPC error #{options['code']})")
+      end
+    end
+  end
+
+  class JsonRpcException < Exception
+  end
+
+  class DuplicateObjectException < Exception
+  end
+
+  class ValidationException < Exception
+    attr_reader :errors
+    def initialize(errs= {})
+      @errors = errs
+    end
+  end
+end

data/lib/mashery/key.rb

@@ -0,0 +1,22 @@
+module Mashery
+  class Key < ApiObjectBase
+    attr_reader :id, :created, :updated, :service_key, :username, :limits
+    attr_accessor :apikey, :status, :rate_limit_ceiling, :qps_limit_ceiling, :rate_limit_exempt, :qps_limit_exempt,
+      :required_referer, :secret
+
+    def self.create(service_key, username, fields = {})
+      fields ||= {}
+      our_fields = fields.merge('service' => {'service_key' => service_key}, 'member' => {'username' => username})
+      super(our_fields)
+    end
+
+    def initialize(data)
+      limits = data.delete('limits')
+      @limits = limits.map {|l| Limit.new(l['period'], l['source'], l['ceiling'])} if limits
+      super
+    end
+  end
+
+  class Limit < Struct.new(:period, :source, :ceiling)
+  end
+end

data/lib/mashery/member.rb

@@ -0,0 +1,24 @@
+module Mashery
+  class Member < ApiObjectBase
+    attr_reader :created, :updated
+    attr_accessor :username, :email, :display_name, :uri, :blog, :im, :imsvc, :phone,
+      :company, :address1, :address2, :locality, :region, :postal_code, :country_code, :first_name, :last_name,
+      :registration_ipaddr, :area_status, :external_id, :passwd_new
+
+    def self.create(username, display_name, email, fields = {})
+      fields ||= {}
+      our_fields = fields.merge('username' => username, 'display_name' => display_name, 'email' => email)
+      super(our_fields)
+    end
+
+    def add_role(role_or_id)
+      role_id = role_or_id.respond_to?(:id) ? role_or_id.id : role_or_id
+      Mashery.client.call_remote('member.addRole', {'username' => username}, {'id' => role_id})
+    end
+
+    def remove_role(role_or_id)
+      role_id = role_or_id.respond_to?(:id) ? role_or_id.id : role_or_id
+      Mashery.client.call_remote('member.removeRole', {'username' => username}, {'id' => role_id})
+    end
+  end
+end

data/lib/mashery/role.rb

@@ -0,0 +1,20 @@
+module Mashery
+  class Role < ApiObjectBase
+    attr_reader :id, :created, :updated, :is_assignable, :is_predefined
+    attr_accessor :name, :description
+
+    def assignable?
+      is_assignable == true
+    end
+
+    def predefined?
+      is_predefined == true
+    end
+
+    def self.create(name, fields = {})
+      fields ||= {}
+      our_fields = fields.merge('name' => name)
+      super(our_fields)
+    end
+  end
+end

data/mashery.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mashery}
+  s.version = "0.0.9"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Moseley"]
+  s.date = %q{2010-08-11}
+  s.email = %q{brian@outside.in}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "LICENSE.txt",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/mashery.rb",
+     "lib/mashery/api_object_base.rb",
+     "lib/mashery/client.rb",
+     "lib/mashery/exceptions.rb",
+     "lib/mashery/key.rb",
+     "lib/mashery/member.rb",
+     "lib/mashery/role.rb",
+     "mashery.gemspec",
+     "tasks/mashery.thor"
+  ]
+  s.homepage = %q{http://github.com/outsidein/mashery-rb}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A Ruby library for the Mashery API}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/tasks/mashery.thor

@@ -0,0 +1,197 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+# XXX: only do this when the task has not been installed
+$: << 'lib'
+
+require 'mashery'
+
+module Mashery
+  class CLI < Thor
+    namespace :mashery
+
+    desc "echo VALUE", "Echo the provided value (tests connectivity and authentication)"
+    def echo(value)
+      run { ok(::Mashery.client.echo(value)) }
+    end
+
+  protected
+    def run(&block)
+      site_id = ENV['MASHERY_SITE_ID'] or
+        raise Exception, "Please set the MASHERY_SITE_ID environment variable."
+      key = ENV['MASHERY_API_KEY'] or
+        raise Exception, "Please set the MASHERY_API_KEY environment variable."
+      secret = ENV['MASHERY_SHARED_SECRET'] or
+        raise Exception, "Please set the MASHERY_SHARED_SECRET environment variable."
+      ::Mashery.client = ::Mashery::Client.new(site_id, key, secret)
+      ::Mashery.logger.level = Logger::DEBUG
+      begin
+        yield
+      rescue ::Mashery::JsonRpcException => e
+        error(e.message)
+      rescue ::Mashery::ValidationException => e
+        e.errors.each {|err| warn("#{err['field']}: #{err['message']}")}
+        error("Unable to execute method due to validation errors")
+      end
+    end
+
+    def warn(msg)
+      say_status :WARN, msg, :yellow
+    end
+
+    def ok(msg)
+      say_status :OK, msg
+    end
+
+    def error(msg)
+      say_status :ERROR, msg, :red
+    end
+
+    def debug(msg)
+      say_status :DEBUG, msg, :cyan
+    end
+  end
+
+  class MemberCLI < CLI
+    namespace 'mashery:member'
+
+    desc "create USERNAME DISPLAY_NAME EMAIL [--fields ...]", "Create a member"
+    method_option :fields, :type => :hash
+    def create(username, display_name, email)
+      run do
+        begin
+          member = ::Mashery::Member.create(username, display_name, email, options[:fields])
+          ok("Member #{member.username} created")
+        rescue ::Mashery::DuplicateObjectException
+          error("The username #{username} has already been claimed")
+        end
+      end
+    end
+
+    desc "fetch USERNAME", "Fetch a member"
+    def fetch(username)
+      run do
+        member = ::Mashery::Member.fetch(username)
+        if member
+          ok("Member #{username} found")
+          say(member.to_yaml)
+        else
+          warn("Member #{username} not found")
+        end
+      end
+    end
+
+    desc "addrole USERNAME ROLE_ID", "Assign a role to a member"
+    def addrole(username, role_id)
+      run do
+        member = ::Mashery::Member.fetch(username)
+        if member
+          role = ::Mashery::Role.fetch(role_id.to_i)
+          if role
+            member.add_role(role)
+            ok("Role #{role.name} assigned to member #{username}")
+          else
+            warn("Role #{role_id} not found")
+          end
+        else
+          warn("Member #{username} not found")
+        end
+      end
+    end
+
+    desc "rmrole USERNAME ROLE_ID", "Revoke a role from a member"
+    def rmrole(username, role_id)
+      run do
+        member = ::Mashery::Member.fetch(username)
+        if member
+          role = ::Mashery::Role.fetch(role_id.to_i)
+          if role
+            member.remove_role(role)
+            ok("Role #{role.name} revoked from member #{username}")
+          else
+            warn("Role #{role_id} not found")
+          end
+        else
+          warn("Member #{username} not found")
+        end
+      end
+    end
+
+    desc "delete USERNAME", "Delete a member"
+    def delete(username)
+      run do
+        ::Mashery::Member.delete(username)
+        ok("Member #{username} deleted")
+      end
+    end
+  end
+
+  class KeyCLI < CLI
+    namespace 'mashery:key'
+
+    desc "create SERVICE_KEY USERNAME [--fields ...]", "Create a key"
+    method_option :fields, :type => :hash
+    def create(service_key, username)
+      run do
+        key = ::Mashery::Key.create(service_key, username, options[:fields])
+        ok("Key #{key.id} created for member #{username} and service #{service_key}")
+      end
+    end
+
+    desc "fetch ID", "Fetch a key"
+    def fetch(id)
+      run do
+        key = ::Mashery::Key.fetch(id.to_i)
+        if key
+          ok("Key #{id} found")
+          say(key.to_yaml)
+        else
+          warn("Key #{id} not found")
+        end
+      end
+    end
+
+    desc "delete ID", "Delete a key"
+    def delete(id)
+      run do
+        ::Mashery::Key.delete(id.to_i)
+        ok("Key #{id} deleted")
+      end
+    end
+  end
+
+  class RoleCLI < CLI
+    namespace 'mashery:role'
+
+    desc "create NAME [--fields ...]", "Create a role"
+    method_option :fields, :type => :hash
+    def create(name)
+      run do
+        role = ::Mashery::Role.create(name, options[:fields])
+        ok("Role #{role.id} created with name #{name}")
+      end
+    end
+
+    desc "fetch ID", "Fetch a role"
+    def fetch(id)
+      run do
+        role = ::Mashery::Role.fetch(id.to_i)
+        if role
+          ok("Role #{id} found")
+          say(role.to_yaml)
+        else
+          warn("Role #{id} not found")
+        end
+      end
+    end
+
+    desc "delete ID", "Delete a role"
+    def delete(id)
+      run do
+        ::Mashery::Role.delete(id.to_i)
+        ok("Role #{id} deleted")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: mashery
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 9
+  version: 0.0.9
+platform: ruby
+authors: 
+- Brian Moseley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-11 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: brian@outside.in
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.textile
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.textile
+- Rakefile
+- VERSION
+- lib/mashery.rb
+- lib/mashery/api_object_base.rb
+- lib/mashery/client.rb
+- lib/mashery/exceptions.rb
+- lib/mashery/key.rb
+- lib/mashery/member.rb
+- lib/mashery/role.rb
+- mashery.gemspec
+- tasks/mashery.thor
+has_rdoc: true
+homepage: http://github.com/outsidein/mashery-rb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A Ruby library for the Mashery API
+test_files: []
+