nutshell-crm-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5e4313404f12a0dd297d7c8160a98189d204f4e
+  data.tar.gz: d5a1e365173d1a0b3c6868969bf260ee2958704c
+SHA512:
+  metadata.gz: 070a8da9f109823ad981b20af96426b5992ca2d70ad89e6101fdc32f032a03742009f26210dc021b1a7ffb2e701e00395ea65e2ea3206fc11feb2c94fc5bc4f2
+  data.tar.gz: 2621cb2fae04b5ea4a1331663fa9dc725ca10304de0ab1ad9c2aea93475c7ca7ee18641674e623673fe01c3c4395580a9b172de1ba96e4d3b694dbb6a1538d00

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+*.rbc
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.2-p290

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+
+env: NUTSHELL_USERNAME=mshafrir@gmail.com NUTSHELL_APIKEY=1d58ccb0eeba08916ed379bc3607c6999e343412

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## v0.0.5
+## v0.0.4
+## v0.0.3
+## v0.0.2
+## v0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in nutshell-crm.gemspec
+gemspec

data/README.md

@@ -0,0 +1,37 @@
+# Nutshell CRM [![Build Status](https://secure.travis-ci.org/mshafrir/nutshell-crm.png)](http://travis-ci.org/mshafrir/nutshell-crm)
+
+Author: [mshafrir@gmail.com](mailto:mshafrir@gmail.com)
+
+## Description ##
+
+Nutshell Crm is a Ruby wrapper for the Nutshell Crm API.
+
+[Nutshell API Reference](http://www.nutshell.com/api/)
+
+## Reference ##
+
+- {NutshellCrm::Client}
+
+
+## Install ##
+
+    gem install nutshell-crm
+    
+
+## Example Usage ##
+
+    require "nutshell-crm"
+
+    # Instantiate the Nutshell client.
+    nutshell = NutshellCrm::Client.new "user@example.com", "MY_API_KEY"
+
+    # Get the first open lead with stub data (default).
+    nutshell.find_leads({status: 0}).first
+    #=> {"stub"=>true, "id"=>1001, "entityType"=>"Leads", "name"=>"Lead\u20131001", "status"=>0, "primaryAccountName"=>nil}
+
+    # Enable non-stub responses.
+    nutshell.stub_responses = false
+
+    # Get the first open lead with full data.
+    nutshell.find_leads({status: 0}).first
+    #=> {"id"=>1001, "entityType"=>"Leads", "name"=>"Lead\u20131001", "status"=>0, "primaryAccountName"=>nil, "creator"=>{}}

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/task'
+require 'rake/testtask'
+
+task :local_test do
+  exec 'rbenv local 1.9.2-p290 && bundle exec rspec spec/nutshell-crm_spec.rb && rbenv local 1.9.3'
+end
+
+task :doc do
+  exec 'yardoc && cp -vR doc/ ../nutshell-crm-docs && cd ../nutshell-crm-docs && git add . && git commit -am "Update documentation." && git push origin gh-pages'
+end
+
+task :default do
+  exec 'bundle exec rspec'
+end

data/lib/nutshell-crm-api.rb

@@ -0,0 +1,471 @@
+require "nutshell-crm-api/version"
+
+require 'json'
+require 'httparty'
+
+# @author Michael Shafrir
+module NutshellCrmAPI
+  class Client
+
+    attr_accessor :api_url
+
+    # Global setting for stubResponses parameter.
+    attr_accessor :stub_responses
+
+    include HTTParty
+    format :json
+
+    # A new instance of the NutshellCrm client.
+    # Configure at https://app01.nutshell.com/setup/api-key
+    #
+    # @param [String] username
+    # @param [String] api_key
+    #   API key
+    def initialize(username, api_key)
+      @username = username
+      @api_key = api_key
+      @stub_responses = nil
+
+      result = exec_request(build_payload({:username => @username}), 'http://api.nutshell.com/v1/json')
+      api_host = result['api']
+      @api_url = "https://#{api_host}/api/v1/json"
+    end
+
+    # Saves the given e-mail message.
+    #
+    # @param [String] e-mail in RFC 822 format
+    def add_email(email_string)
+      exec_request build_payload({:emailString => email_string})
+    end
+
+    # Gets all of the custom fields available for Leads, Accounts and Contacts, including appropriate meta-information.
+    #
+    # @return [Object] the custom fields available for Leads, Accounts and Contacts, including appropriate meta-information 
+    def describe_custom_fields
+      exec_request build_payload
+    end
+
+    # Edit an account.
+    #
+    # @param [Integer] account_id
+    #   account ID to edit
+    # @param [String] rev
+    #   the revision
+    # @param [Hash] account
+    #   updated account information
+    def edit_account(account_id, rev, account)
+      exec_request build_payload({:accountId => account_id, :rev => rev, :account => account})
+    end
+
+    # Edit an activity.
+    def edit_activity(activity_id, rev, activity)
+      exec_request build_payload({:activityId => activity_id, :rev => rev, :activity => activity})
+    end
+
+    # Edit a contact.
+    def edit_contact(contact_id, rev, contact)
+      exec_request build_payload({:contactId => contact_id, :rev => rev, :contact => contact})
+    end
+
+    # Edit a lead.
+    def edit_lead(lead_id, rev, lead)
+      exec_request build_payload({:leadId => lead_id, :rev => rev, :lead => lead})
+    end
+
+    # Update a process step.
+    def edit_step(step_id, rev, step)
+      exec_request build_payload({:stepId => step_id, :rev => rev, :step => step})
+    end
+
+    # Edit a task.
+    def edit_task(task_id, rev, task)
+      exec_request build_payload({:taskId => task_id, :rev => rev, :task => task})
+    end
+
+    # Find accounts matching a specified query.
+    def find_accounts(query, order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
+      params = {:query => query, :orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page, :stubResponses => stub_responses}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active account types (to be applied to an account).
+    def find_account_types(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Find activities matching a specified query. 
+    def find_activities(query, order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
+      params = {:query => query, :orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page, :stubResponses => stub_responses}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active activity types.
+    def find_activity_types(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active Competitors.
+    def find_competitors(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Find contacts associated with a specified account or lead.
+    def find_contacts(query, order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
+      params = {:query => query, :orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page, :stubResponses => stub_responses}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active Delays (seen in Step responses in availableDelayIds).
+    def find_delays(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active Industries (to be applied to an account)
+    def find_industries(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all possible outcomes for a closed lead.
+    def find_lead_outcomes(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params, 'findLead_Outcomes'
+      exec_request(payload)
+    end
+
+    # Find leads matching a specified query.
+    def find_leads(query, order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
+      params = {:query => query, :orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page, :stubResponses => stub_responses}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active markets.
+    def find_markets(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active milestones.
+    def find_milestones(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active Origins.
+    def find_origins(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active products.
+    def find_products(order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page, :stubResponses => stub_responses}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Return all publicly-visible settings.
+    def find_settings(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active Sources.
+    def find_sources(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active tags.
+    def find_tags
+      exec_request build_payload
+    end
+
+    # Returns an array containing tasks for the given query.
+    def find_tasks(query)
+      params = {:query => query}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active Teams.
+    def find_teams(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all territories.
+    def find_territories(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Find timeline events (Activities, Emails and Notes) for an Entity.
+    def find_timeline(query, order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
+      params = {:query => query, :orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page, :stubResponses => stub_responses}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get all active Users.
+    def find_users(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {:orderBy => order_by, :orderDirection => order_direction, :limit => limit, :page => page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    # Get the specified Account.
+    def get_account(account_id, rev = nil)
+      params = {:accountId => account_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    # Get the specified Activity.
+    def get_activity(activity_id, rev = nil)
+      params = {:activityId => activity_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    # Returns graph data and overview information for various sales analytics reports.
+    def getAnalyticsReport(report_type, period, filter_entity = nil, options = nil)
+      params = {:reportType => report_type, :period => period, :filter => filter_entity, :options => options}
+      exec_request build_payload(params)
+    end
+
+    # Get the specified Contact.
+    def get_contact(contact_id, rev = nil)
+      params = {:contactId => contact_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    # Get the specified Email.
+    def get_email(email_id, rev = nil)
+      params = {:emailId => email_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    # Get the specified lead.
+    def get_lead(lead_id, rev = nil)
+      params = {:leadId => lead_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    # Return all mobile-related settings in a simple key-value array.
+    def get_mobile_settings
+      exec_request build_payload
+    end
+
+    # Get the specified Note.
+    def get_note(note_id, rev = nil)
+      params = {:noteId => note_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    # Get all information for a product (including full price list).
+    def get_product(product_id, rev = nil)
+      params = {:productId => product_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    def get_task(task_id, rev = nil)
+      params = {:taskId => task_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    # Gets the last-updated times of each of the provisioning bins.
+    def get_update_times
+      exec_request build_payload
+    end
+
+    # Get all info about a user.
+    def get_user(user_id = nil, rev = nil)
+      params = {:userId => user_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    # Create a new account.
+    def new_account(account)
+      exec_request build_payload({:account => account})
+    end
+
+    # Create a new activity.
+    def new_activity(activity)
+      exec_request build_payload({:activity => activity})
+    end
+
+    # Create a new contact.
+    def new_contact(contact)
+      exec_request build_payload({:contact => contact})
+    end
+
+    # Create a new Lead.
+    def new_lead(lead)
+      exec_request build_payload({:lead => lead})
+    end
+
+    # Create a new Lead.
+    def new_note(entity, note)
+      exec_request build_payload({:entity => entity, :note => note})
+    end
+
+    # Create a new tag.
+    #
+    # @param [Hash] tag
+    #   See {Nut_Api_Render_Model_Tag}[http://www.nutshell.com/api/detail/class_nut___api___render___model___tag.html]
+    def new_tag(tag)
+      exec_request build_payload({:tag => tag})
+    end
+
+    # Create a new Task.
+    def new_task(task)
+      exec_request build_payload({:task => task})
+    end
+
+    # Return a list of Account stubs matching a given search string.
+    def search_accounts(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    # Works just like searchUniversal, but only searches by email address.
+    def search_by_email(email_address)
+      exec_request build_payload({:emailAddressString => email_address})
+    end
+
+    # Return a list of Competitor stubs matching a given search string.
+    def search_competitors(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    # Return a list of Contact stubs matching a given search string.
+    def search_contacts(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    # Return a list of Contact and User stubs matching a given search string.
+    def search_contacts_and_users(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    # Return a list of Lead stubs matching a given search string.
+    def search_leads(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    # Return a list of Product stubs matching a given search string.
+    def search_products(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    # Return a list of Source stubs matching a given search string.
+    def search_sources(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    # Return a list of Contact, Lead, and Account stubs matching a given search string.
+    def search_universal(query)
+      exec_request build_payload({:string => query})
+    end
+
+    # Return a list of User and Team stubs matching a given search string.
+    def search_users_and_teams(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    # Delete an Activity 
+    def delete_activity(activity_id, rev)
+        params = {:activityId => activity_id, :rev => rev}
+        payload = build_payload params
+        exec_request(payload)
+    end
+
+    def delete_task(task_id, rev)
+        params = {:taskId => task_id, :rev => rev}
+        payload = build_payload params
+        exec_request(payload)
+    end
+
+
+    private
+
+    # Builds the payload for a request.
+    #
+    # @param [Hash] params 
+    # @param [String] override_method
+    #   needed if the Nutshell API method cannot be determined from the class method name
+    # @return [String] the payload in JSON format
+    def build_payload(params = nil, override_method = nil)
+      # Calculate the Nutshell API method name based on the Ruby method name (with a few exceptions)
+      if override_method.nil?
+        method = caller[0][/`.*'/][1..-2]
+        method = 'getApiForUsername' if method == 'initialize'
+      else
+        method = override_method
+      end
+
+      if (not params.nil?) && params.has_key?(:stubResponses) && (not @stub_responses.nil?)
+        params[:stubResponses] = @stub_responses
+      end
+
+      # Create the payload
+      payload = {:method => camelcase(method), :id => generate_request_id}
+
+      # Filter out keys with nil values.
+      payload[:params] = params.reject {|k,v| v.nil?} unless params.nil?
+
+      # Return as JSON
+      payload.to_json
+    end
+
+
+    # All Nutshell API requests need a request id.
+    #
+    # @return [String] request id
+    def generate_request_id
+      Digest::MD5.hexdigest(rand.to_s).slice(0..8)
+    end
+
+    # Executes an arbitrary request.
+    def exec_request(payload, override_url = nil)
+      response = HTTParty.post(override_url.nil? ? @api_url : override_url,
+        :basic_auth => {:username => @username, :password => @api_key},
+        :body => payload,
+        :query => {:output => :json}
+      )
+
+      unless response['error'].nil?
+        error = response['error']
+        error_code = error['code']
+        error_msg = error['message']
+        raise "Nutshell API Error: #{error_msg} (#{error_code})"
+      end
+
+      response['result']
+    end
+
+    def camelcase(method_name)
+      parts = []
+      method_name.split('_').each_with_index {|str, idx| parts << (idx == 0 ? str : str.capitalize)}
+      parts.join ''
+    end
+  end
+end

data/lib/nutshell-crm-api/version.rb

@@ -0,0 +1,3 @@
+module NutshellCrm
+  VERSION = "0.1.0"
+end

data/nutshell-crm-api.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nutshell-crm-api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nutshell-crm-api"
+  s.version     = NutshellCrm::VERSION
+  s.authors     = ["Christian Juth"]
+  s.email       = ["cjuth2@gmail.com"]
+  s.homepage    = "https://github.com/Christianjuth/nutshell-crm-api"
+  s.summary     = "A Ruby wrapper for Nutshell CRM's API"
+  s.description = "Nutshell CRM's API"
+  s.license     = "MIT"
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'rspec'
+
+  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'httparty'
+
+
+  s.rubyforge_project = "nutshell-crm-api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/nutshell-crm_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe NutshellCrm::Client do
+  before :all do
+    @api_username = ENV['NUTSHELL_USERNAME']
+    @api_key = ENV['NUTSHELL_APIKEY']
+    @nutshell = NutshellCrm::Client.new @api_username, @api_key
+    @categories = ['Contacts', 'Accounts', 'Leads']
+  end
+
+  context 'client authentication errors' do
+    it 'should set up a new client instance with an invalid username and raise an error' do
+      lambda { NutshellCrm::Client.new('invalid@example.com', 'APIKEY123456') }.should raise_error
+    end
+
+    it 'should set up a new client instance with a valid username but invalid API key and raise an error' do
+      nutshell = NutshellCrm::Client.new(@api_username, 'APIKEY123456')
+      lambda { nutshell.find_leads({:status => 0}) }.should raise_error
+    end
+  end
+
+  subject { @nutshell }
+
+  context 'after a new Nutshell client has been instantiated' do
+    it 'should get a valid API service url that starts with https://' do
+      @nutshell.api_url.should match 'https://'
+    end
+
+    it 'should consider global stub_response property settings' do
+      @nutshell.stub_responses = false
+      @nutshell.find_leads({:status => 0}).first['stub'].should_not be true
+      @nutshell.stub_responses = true
+      @nutshell.find_leads({:status => 0}).first['stub'].should be true
+      @nutshell.stub_responses = nil
+    end
+
+    it 'should find open leads' do
+      @nutshell.find_leads({:status => 0}).should_not be_empty
+    end
+
+    it 'should describe custom fields' do
+      custom_fields = @nutshell.describe_custom_fields
+      (custom_fields.all? {|k,v| @categories.include? k}).should be_true
+    end
+
+    it 'should find tags' do
+      tags = @nutshell.find_tags
+      (tags.all? {|k,v| @categories.include? k}).should be_true
+    end
+
+    it 'should get update times for each provisioning bin' do
+      @nutshell.get_update_times.should_not be_empty
+    end
+
+    it 'should return universal search results' do
+      @nutshell.search_universal('A').should_not be_empty
+    end
+
+    it 'should create a new tag and find it' do
+      lambda {
+        @nutshell.new_tag({:name => 'FOO2', :entityType => 'Leads'})
+        @nutshell.new_tag({:name => 'FOO2', :entityType => 'Leads'})
+      }.should raise_error
+    end
+
+    it 'should return product info' do
+      product = @nutshell.get_product(1)
+      product.should_not be_empty
+    end
+
+    it 'should return mobile settings' do
+      mobile_settings = @nutshell.get_mobile_settings
+      mobile_settings.should_not be_empty
+    end
+
+    it 'should return the logged in user' do
+      user = @nutshell.get_user
+    end
+
+    it 'should get and edit a lead' do
+      lead_id = 1001
+      lead = @nutshell.get_lead(lead_id)
+      rev = lead['rev']
+      @nutshell.edit_lead(lead_id, rev, {:description => 'Testing edit.'})
+    end
+
+    it 'should return the sources' do
+      @nutshell.search_sources('Cold')
+    end
+
+    it 'should update a process step' do
+      step = @nutshell.get_lead(1001)['processes'][0]['steps'][0]
+      current_status = step['status'].to_i
+
+      if current_status < 2
+        @nutshell.edit_step(step['id'], step['rev'], {:status => 2})
+      else
+        lambda { @nutshell.edit_step(step['id'], step['rev'], {:status => 2}) }.should raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'nutshell-crm-api' # and any other gems you need
+

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: nutshell-crm-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Juth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Nutshell CRM's API
+email:
+- cjuth2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rbenv-version"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/nutshell-crm-api.rb
+- lib/nutshell-crm-api/version.rb
+- nutshell-crm-api.gemspec
+- spec/nutshell-crm_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Christianjuth/nutshell-crm-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: nutshell-crm-api
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for Nutshell CRM's API
+test_files:
+- spec/nutshell-crm_spec.rb
+- spec/spec_helper.rb
+has_rdoc: