answers-ruby-client 0.0.1

data/spec/client_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'pry'
+
+describe Answers::Client do  
+  context 'When no API keys are provided' do
+    before(:all) { Answers.reset! }
+    after(:all) { Answers.reset! }
+    
+    it 'creates a Client instance when ::init is called' do
+      expect do 
+        Answers.reset!
+        Answers.client
+      end.to raise_error(Answers::Error)
+      
+      Answers.init
+      
+      expect(Answers.client).to(be_a(Answers::Client))
+    end
+  end
+  
+  context 'When API keys are provided' do
+    before(:all) { Answers.reset! }
+    after(:all) { Answers.reset! }
+    
+    it 'appends those keys to the request header' do
+      keys = {
+        user_email: 'fake@email.tld',
+        user_token: 'fake_token'
+      }
+      Answers.init keys
+      
+      headers = Answers.client.connection.headers
+            
+      expect(headers).to(include(
+        Answers::Protocol::EMAIL_HEADER_KEY => keys[:user_email]),
+        Answers::Protocol::TOKEN_HEADER_KEY => keys[:user_token]
+      )
+    end
+  end
+  
+  context 'When the user must supply a non-default URL' do
+    before(:all) { Answers.reset! }
+    after(:all) { Answers.reset! }
+    
+    it 'accepts a :url param in the constructor' do
+      new_url = 'https://my-non-default.url/'
+      Answers.init({
+        url: new_url
+      })
+      
+      expect(Answers.client.connection.build_url.to_s).to(eq(new_url))
+    end
+  end
+  
+  context 'Regardless of whether or not API keys are provided' do
+    before(:all) { Answers.reset! }
+    after(:all) { Answers.reset! }
+    
+    let(:client) do
+      Answers.init
+      Answers.client
+    end
+
+    it 'has a #get method' do
+      expect(client).to(respond_to(:get))
+    end
+    
+    it 'has a #post method' do
+      expect(client).to(respond_to(:post))
+    end
+    
+    it 'has a #put method' do
+      expect(client).to(respond_to(:put))
+    end
+    
+    it 'has a #delete method' do
+      expect(client).to(respond_to(:delete))
+    end
+  end
+end

data/spec/question_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+require 'pry'
+
+describe Answers::Question, :vcr do
+  context 'When API keys are not provided' do
+    
+    before(:all) { Answers.reset! }
+    after(:all) { Answers.reset! }
+    before(:each) { Answers.init }
+    
+    describe "GET index" do
+      let(:questions) do
+        Answers::Question.all
+      end
+      
+      it "retrieves a list of Questions" do
+        expect(questions).to(be_a(Array))
+      end
+      
+      it "contains objects only of type Answer::Question" do
+        types = questions.map {|q| q.class}.uniq
+        expect(types.length).to(eq(1))
+        expect(types.first).to(eq(Answers::Question))
+      end
+    end
+    
+    describe "GET show" do
+      let(:question) { Answers::Question.find(1) }
+      
+      it "retrieves a single object of type Answers::Question" do
+        expect(question).to(be_a(Answers::Question))
+      end
+    end
+    
+    describe "POST create" do
+      it "throws an Answers::Error" do
+        question = Answers::Question.new
+        question.text = 'sample'
+        question.in_language = 'english'
+        
+        expect { question.save }.to raise_error(Answers::Error)
+      end
+    end
+    
+    describe "PUT update" do
+      it "throws an Answers::Error" do
+        question = Answers::Question.find(1)
+        question.text = 'revised'
+        
+        expect { question.save }.to raise_error(Answers::Error)
+      end
+    end
+    
+    describe "DELETE destroy" do
+      it "throws an Answers::Error" do
+        question = Answers::Question.find(1)
+        
+        expect { question.delete }.to raise_error(Answers::Error)
+      end
+    end
+
+  end
+  
+  context 'When API keys are provided' do
+    before(:all) { Answers.reset! }
+    after(:all) { Answers.reset! }
+    
+    before(:each) do
+      Answers.init({
+        user_email: ENV['ANSWERS_USER_EMAIL'],
+        user_token: ENV['ANSWERS_USER_TOKEN']
+      })
+    end
+    
+    describe "POST create" do
+      it "creates an Answer::Question" do
+        question = Answers::Question.new
+        question.text = 'sample'
+        question.in_language = 'english'
+        
+        old_created_at = question.created_at
+        old_id = question.id
+        
+        question.save
+        
+        new_id = question.id
+        new_created_at = question.created_at
+        
+        expect(old_id).to(be(nil))
+        expect(old_created_at).to(be(nil))
+        expect(new_id).to(be_a(Fixnum))
+        expect(new_created_at).to(be_a(String))
+      end
+    end
+    
+    describe "PUT update" do
+      it "updates an Answer::Question" do
+        question = Answers::Question.find(1)
+
+        old_updated_at = question.updated_at
+        question.text = 'new_text'
+        question.save
+        
+        #expect(question.updated_at).not_to(eq(old_updated_at))
+
+      end
+    end
+    
+    describe "DELETE destroy" do
+      it "deletes an Answer::Question" do
+        question = Answers::Question.new
+        question.text = 'sample'
+        question.in_language = 'english'
+        question.save
+        
+        question_to_delete = Answers::Question.find(question.id)
+        question_to_delete.delete
+        query = Answers::Question.find(question.id)
+        
+        expect(query).to(be(nil))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.default_cassette_options = { record: :new_episodes }
+end
+
+require 'dotenv'
+Dotenv.load
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'answers-ruby-client'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,259 @@
+--- !ruby/object:Gem::Specification
+name: answers-ruby-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alan deLevie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: dotenv
+  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: coveralls
+  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: webmock
+  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: vcr
+  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: faraday
+  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: faraday_middleware
+  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: activesupport
+  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: Access the the Answers Platform's read/write API in idiomatic Ruby.
+email:
+- alan.delevie@gsa.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".rbenv-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- answers-ruby-client.gemspec
+- lib/answers-ruby-client.rb
+- lib/answers/answer.rb
+- lib/answers/base_model.rb
+- lib/answers/client.rb
+- lib/answers/error.rb
+- lib/answers/protocol.rb
+- lib/answers/question.rb
+- lib/answers/version.rb
+- spec/answer_spec.rb
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/DELETE_destroy/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/GET_index/contains_objects_only_of_type_Answer_Answer.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/GET_index/retrieves_a_list_of_Answers.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/GET_show/retrieves_a_single_object_of_type_Answers_Answer.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/POST_create/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/PUT_update/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_provided/DELETE_destroy/deletes_an_Answer_Answer.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_provided/POST_create/creates_an_Answer_Answer.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_provided/PUT_update/updates_an_Answer_Answer.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/DELETE_destroy/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/GET_index/contains_objects_only_of_type_Answer_Question.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/GET_index/retrieves_a_list_of_Questions.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/GET_show/retrieves_a_single_object_of_type_Answers_Question.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/POST_create/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/PUT_update/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_provided/DELETE_destroy/deletes_an_Answer_Question.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_provided/POST_create/creates_an_Answer_Question.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_provided/PUT_update/updates_an_Answer_Question.yml
+- spec/client_spec.rb
+- spec/question_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- Public Domain (see LICENSE.txt)
+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: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Low level Ruby client to access the Answers Platform API.
+test_files:
+- spec/answer_spec.rb
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/DELETE_destroy/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/GET_index/contains_objects_only_of_type_Answer_Answer.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/GET_index/retrieves_a_list_of_Answers.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/GET_show/retrieves_a_single_object_of_type_Answers_Answer.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/POST_create/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_not_provided/PUT_update/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_provided/DELETE_destroy/deletes_an_Answer_Answer.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_provided/POST_create/creates_an_Answer_Answer.yml
+- spec/cassettes/Answers_Answer/When_API_keys_are_provided/PUT_update/updates_an_Answer_Answer.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/DELETE_destroy/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/GET_index/contains_objects_only_of_type_Answer_Question.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/GET_index/retrieves_a_list_of_Questions.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/GET_show/retrieves_a_single_object_of_type_Answers_Question.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/POST_create/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_not_provided/PUT_update/throws_an_Answers_Error.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_provided/DELETE_destroy/deletes_an_Answer_Question.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_provided/POST_create/creates_an_Answer_Question.yml
+- spec/cassettes/Answers_Question/When_API_keys_are_provided/PUT_update/updates_an_Answer_Question.yml
+- spec/client_spec.rb
+- spec/question_spec.rb
+- spec/spec_helper.rb