tin_can_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d896c743e9aa76b46e6e9ae50850de428a5839a6
-  data.tar.gz: 10d4216bb0f21b333a23791c63ff8807f0b95dff
+  metadata.gz: 34eb8a3a0790178d886e761965671f776b61257d
+  data.tar.gz: 7078806b6b01848da7096efb4ec86cf39053a0c8
 SHA512:
-  metadata.gz: 236685666c862527a6cd11a365d8f1eef97bf079fbb8cc3b225ec99ce0412561366922ab25bdf0138a01cd29fb267f08c2b113190b71e0c69eedea7b3f482764
-  data.tar.gz: 1ac0a3b83e6aa3fca486a082ada827703db11dc88311eedf17089303388d1c9820a250f5c88590da9661e45fc9889f13cf73c6292afb9b15fa4fca89dc31f7f2
+  metadata.gz: 83e078eddade7130ed70c6c9277af8192adfe53d79f78ccc0106d8f2e901c35212e0df0f7a68e8e09c9ab3814554b093263a764bb975a172f9cc81347443aec7
+  data.tar.gz: 14bd8ef72039acbbd3fe49545f1a94bc646a16443098cc2711386f672afc8fb63ebaa7cd8a4625ea83e88e27fec8bda66cf1e962e5234e625f239206e341536c

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+## Contributing
+
+1. Fork it ( https://github.com/pwcoleman/tin_can_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/README.md

@@ -28,9 +28,9 @@ Or install it yourself as:
 
 ## Usage
 
-Create a client using basic auth
+Create a remote LRS using basic auth
 ```ruby
-client = TinCanApi::Client.new do |c|
+remote_lrs = TinCanApi::RemoteLRS.new do |c|
   c.end_point = 'https://some.endpoint.com'
   c.user_name = 'user'
   c.password = 'password'
@@ -40,8 +40,8 @@ end
 Connect to the 'about' endpoint to get version information
 
 ```ruby
-# use the client from above
-response = client.about
+# use the remote LRS from above
+response = remote_lrs.about
 # check if it is successful
 if response.success
     # access the TinCanApi::About instance
@@ -62,19 +62,12 @@ statement = TinCanApi::Statement.new do |s|
   s.object = activity
 end
 
-response = client.save_statement(statement)
+response = remote_lrs.save_statement(statement)
 if response.success
   # access the statement
   response.content
 end
 ```
 
-For more API calls check out the TinCanApi::Client class
+For more API calls check out the TinCanApi::RemoteLRS class
 
-## Contributing
-
-1. Fork it ( https://github.com/pwcoleman/tin_can_api/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/lib/tin_can_api.rb

@@ -25,7 +25,6 @@ require 'tin_can_api/statements_query'
 require 'tin_can_api/statements_query_v095'
 require 'tin_can_api/lrs_response'
 require "tin_can_api/remote_lrs"
-require 'tin_can_api/client'
 
 begin
   require 'pry'

data/lib/tin_can_api/remote_lrs.rb

@@ -1,14 +1,402 @@
 # encoding: utf-8
+require 'faraday'
+require 'addressable/uri'
 require 'tin_can_api/tcapi_version'
 module TinCanApi
   # Class used to communicate with a TCAPI endpoint synchronously
   class RemoteLRS
     include TinCanApi::TCAPIVersion
 
+    VALID_PARAMS = %w(end_point user_name password version)
+
     attr_accessor :end_point, :user_name, :password, :version
 
-    def initialize(version=V101)
-      @version = version
+    def initialize(options={}, &block)
+      setup_options(options)
+      yield_or_eval(&block) if block_given?
+      @version ||= latest_version
+    end
+
+    def about
+      response = connection.get("#{path}about")
+      LrsResponse.new do |lrs|
+        lrs.status = response.status
+        if response.status== 200
+          lrs.content = About.new(json: response.body)
+          lrs.success = true
+        else
+          lrs.success = false
+        end
+      end
+    end
+
+    def save_statement(statement)
+      # TODO: Complete this
+      if statement.id
+        response = connection.put do |req|
+          req.url("#{path}statements")
+          req.headers['Content-Type'] = 'application/json'
+          req.params.merge!({'statementId' => statement.id})
+          req.body = statement.serialize(latest_version).to_json
+        end
+      else
+        response = connection.post do |req|
+          req.url("#{path}statements")
+          req.headers['Content-Type'] = 'application/json'
+          req.body = statement.serialize(latest_version).to_json
+        end
+      end
+      LrsResponse.new do |lrs|
+        lrs.status = response.status
+        lrs.content = statement
+        if response.status == 200
+          statement.id = JSON.parse(response.body).first
+          lrs.success = true
+        elsif response.status == 204
+          lrs.success = true
+        else
+          lrs.success = false
+        end
+      end
+    end
+
+    def save_statements(statements)
+      # TODO: Complete this
+      if statements.empty?
+        return LrsResponse.new do |lrs|
+          lrs.success = true
+        end
+      end
+      response = connection.post do |req|
+        req.url("#{path}statements")
+        req.headers['Content-Type'] = 'application/json'
+        req.body = statements.map {|s| s.serialize(latest_version)}.to_json
+      end
+      LrsResponse.new do |lrs|
+        lrs.status = response.status
+        if response.status == 200
+          lrs.content = statements
+          ids = JSON.parse(response.body)
+          statements.each_with_index do |statement, index|
+            statement.id = ids[index]
+          end
+          lrs.success = true
+        else
+          lrs.success = false
+        end
+      end
+    end
+
+    def retrieve_statement(id)
+      get_statement(id, 'statementId')
+    end
+
+    def retrieve_voided_statement(id)
+      param_name = version == TCAPIVersion.V095 ? 'statementId' : 'voidedStatementId'
+      get_statement(id, param_name)
+    end
+
+    def query_statements(statement_query)
+      # TODO: Complete this
+      query = statement_query
+      unless query
+        query = version == TCAPIVersion::V095 ? StatementsQueryV095.new : StatementsQuery.new
+      end
+      # Error if the query parameters don't match the LRS version
+      raise Errors::IncompatibleTCAPIVersion, "Attempted to issue #{version} query using a #{query.version} set of query parameters." unless version == query.version
+
+      response = connection.get do |req|
+        req.url("#{path}statements")
+        req.params.merge!(query.parameter_map)
+      end
+      LrsResponse.new do |lrs|
+        lrs.status = response.status
+        if response.status == 200
+          # TODO: FIX THIS
+          lrs.success = true
+          lrs.content = StatementsResult.new(json: response.body)
+        else
+          lrs.success = false
+        end
+      end
+    end
+
+    def more_statements(more_url)
+      # TODO: Complete this
+      # more_url is relative to the endpoint's server root
+      response = connection.get do |req|
+        req.url("#{path}#{more_url}")
+      end
+      LrsResponse.new do |lrs|
+        lrs.status = response.status
+        if response.status == 200
+          # TODO: FIX THIS
+          lrs.success = true
+          lrs.content = StatementsResult.new(json: response.body)
+        else
+          lrs.success = false
+        end
+      end
+    end
+
+    def retrieve_state_ids(activity, agent, registration)
+      # TODO: Complete this
+      query_params = {
+          'activityId' =>  activity.id,
+          'agent' => agent.serialize(version).to_json
+      }
+      query_params['registration'] = registration if registration
+      get_profile_keys('activities/state', query_params)
+    end
+
+    def retrieve_state(id, activity, agent, registration)
+      # TODO: Complete this
+      query_params = {
+          'stateId' => id,
+          'activityId' => activity.id,
+          'agent' => agent.serialize(version).to_json
+      }
+      document = StateDocument.new do |sd|
+        sd.id = id
+        sd.activity = activity
+        sd.agent = agent
+      end
+      lrs_response = get_document('activities/state', query_params, document)
+      if lrs_response.status == 200
+        lrs_response.content = document
+      end
+      lrs_response
+    end
+
+    def save_state(state)
+      # TODO: Complete this
+      query_params = {
+          'stateId' => state.id,
+          'activityId' => state.activity.id,
+          'agent' => state.agent.serialize(version).to_json
+      }
+      save_document('activities/state', query_params, state)
+    end
+
+    def delete_state(state)
+      # TODO: Complete this
+      query_params = {
+          'stateId' => state.id,
+          'activityId' => state.activity.id,
+          'agent' => state.agent.serialize(version).to_json
+      }
+      query_params['registration'] = state.registration if state.registration
+      delete_document('activities/state', query_params)
+    end
+
+    def clear_state(activity, agent, registration)
+      # TODO: Complete this
+      query_params = {
+          'activityId' => activity.id,
+          'agent' => agent.serialize(version).to_json
+      }
+      query_params['registration'] = registration if registration
+      delete_document('activities/state', query_params)
+    end
+
+    def retrieve_activity_profile_ids(activity)
+      # TODO: Complete this
+      query_params = {
+          'activityId' => activity.id
+      }
+      get_profile_keys('activities/profile', query_params)
+    end
+
+    def retrieve_activity_profile(id, activity)
+      # TODO: Complete this
+      query_params = {
+          'profileId' => id,
+          'activityId' => activity.id,
+      }
+      document = ActivityProfileDocument.new do |apd|
+        apd.id = id
+        apd.activity = activity
+      end
+      lrs_response = get_document('activities/profile', query_params, document)
+      if lrs_response.status == 200
+        lrs_response.content = document
+      end
+      lrs_response
+    end
+
+    def save_activity_profile(profile)
+      # TODO: Complete this
+      query_params = {
+          'profileId' => profile.id,
+          'activityId' => profile.activity.id,
+      }
+      save_document('activities/profile', query_params, profile)
+    end
+
+    def delete_activity_profile(profile)
+      # TODO: Complete this
+      query_params = {
+          'profileId' => profile.id,
+          'activityId' => profile.activity.id,
+      }
+      delete_document('activities/profile', query_params)
+    end
+
+    def retrieve_agent_profile_ids(agent)
+      # TODO: Complete this
+      query_params = {
+          'agent' => agent.serialize(version).to_json
+      }
+      get_profile_keys('agents/profile', query_params)
+    end
+
+    def retrieve_agent_profile(id, agent)
+      # TODO: Complete this
+      query_params = {
+          'profileId' => id,
+          'agent' => agent.serialize(version).to_json
+      }
+      document = AgentProfileDocument.new do |apd|
+        apd.id = id
+        apd.agent = agent
+      end
+      lrs_response = get_document('agents/profile', query_params, document)
+      if lrs_response.status == 200
+        lrs_response.content = document
+      end
+      lrs_response
+    end
+
+    def save_agent_profile(profile)
+      # TODO: Complete this
+      query_params = {
+          'profileId' => profile.id,
+          'agent' => profile.agent.serialize(version).to_json
+      }
+      save_document('agents/profile', query_params, profile)
+    end
+
+    def delete_agent_profile(profile)
+      # TODO: Complete this
+      query_params = {
+          'profileId' => profile.id,
+          'agent' => profile.agent.serialize(version).to_json
+      }
+      delete_document('agents/profile', query_params)
+    end
+
+    private
+
+    def setup_options(options={})
+      options.each_pair do |key, value|
+        if value && VALID_PARAMS.include?(key.to_s)
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+
+    def yield_or_eval(&block)
+      return unless block
+      block.arity < 1 ? instance_eval(&block) : block[self]
+    end
+
+    def uri
+      @uri ||= Addressable::URI.parse(end_point)
+    end
+
+    def path
+      @path ||= uri.path
+      @path += '/' unless @path.end_with?('/')
+      @path
+    end
+
+    def connection
+      base_url = "#{uri.scheme}://#{uri.host}"
+      base_url = "#{base_url}:#{uri.port}" if uri.port
+      @connection ||= Faraday.new(:url => base_url) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        faraday.headers['X-Experience-API-Version'] = version.to_s
+        faraday.basic_auth(user_name, password)
+      end
+    end
+
+    def get_statement(id, parameter)
+      response = connection.get do |req|
+        req.url("#{path}statements")
+        req.headers['Content-Type'] = 'application/json'
+        req.params.merge!({parameter => id})
+      end
+      LrsResponse.new do |lrs|
+        lrs.status = response.status
+        if response.status== 200
+          lrs.content = Statement.new(json: response.body)
+          lrs.success = true
+        else
+          lrs.success = false
+        end
+      end
+    end
+
+    def get_document(resource, params, document)
+      response = connection.get do |req|
+        req.url("#{path}#{resource}")
+        req.params.merge!(params)
+      end
+      LrsResponse.new do |lrs|
+        lrs.status = response.status
+        if response.status == 200
+          lrs.success = true
+          # TODO FIX THIS
+        elsif response.status == 404
+          lrs.success = true
+        else
+          lrs.success = false
+        end
+      end
+    end
+
+    def delete_document(resource, params)
+      response = connection.delete do |req|
+        req.url("#{path}#{resource}")
+        req.params.merge!(params)
+      end
+      LrsResponse.new do |lrs|
+        lrs.status = response.status
+        if response.status == 204
+          lrs.success = true
+        else
+          lrs.success = false
+        end
+      end
+    end
+
+    def save_document(resource, params, document)
+      # TODO: Complete this
+      response = connection.put do |req|
+        req.url("#{path}#{resource}")
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['If-Match'] = document.etag if document.etag
+        req.params.merge!(params)
+        req.body = document.content
+      end
+      LrsResponse.new do |lrs|
+        lrs.status = response.status
+        if response.status == 204
+          lrs.success = true
+        else
+          lrs.success = false
+        end
+      end
+    end
+
+    def get_profile_keys(resource, params)
+      # TODO FIX THIS
+      connection.get do |req|
+        req.url("#{path}#{resource}")
+        req.params.merge!(params)
+      end
     end
 
   end

data/lib/tin_can_api/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module TinCanApi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/tin_can_api/{client_spec.rb → remote_lrs_spec.rb}

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require 'spec_helper'
 
-describe TinCanApi::Client do
+describe TinCanApi::RemoteLRS do
   include Helpers
 
   describe 'about' do
@@ -13,13 +13,13 @@ describe TinCanApi::Client do
               body: fixture('about.json'),
               headers: {})
 
-      client = TinCanApi::Client.new do |c|
+      remote_lrs = TinCanApi::RemoteLRS.new do |c|
         c.end_point = 'http://www.example.com'
         c.user_name = 'user'
         c.password = 'password'
       end
 
-      response = client.about
+      response = remote_lrs.about
       expect(response.success).to be(true)
     end
 
@@ -31,13 +31,13 @@ describe TinCanApi::Client do
               body: fixture('about.json'),
               headers: {})
 
-      client = TinCanApi::Client.new do |c|
+      remote_lrs = TinCanApi::RemoteLRS.new do |c|
         c.end_point = 'http://www.example.com'
         c.user_name = 'user'
         c.password = 'password'
       end
 
-      response = client.about
+      response = remote_lrs.about
       expect(response.content).to be_a(TinCanApi::About)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tin_can_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Paul Coleman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -143,7 +144,6 @@ files:
 - lib/tin_can_api/agent.rb
 - lib/tin_can_api/agent_account.rb
 - lib/tin_can_api/attachment.rb
-- lib/tin_can_api/client.rb
 - lib/tin_can_api/context.rb
 - lib/tin_can_api/context_activities.rb
 - lib/tin_can_api/documents/activity_profile_document.rb
@@ -179,11 +179,11 @@ files:
 - spec/tin_can_api/agent_account_spec.rb
 - spec/tin_can_api/agent_spec.rb
 - spec/tin_can_api/attachment_spec.rb
-- spec/tin_can_api/client_spec.rb
 - spec/tin_can_api/context_activities_spec.rb
 - spec/tin_can_api/context_spec.rb
 - spec/tin_can_api/group_spec.rb
 - spec/tin_can_api/interaction_component_spec.rb
+- spec/tin_can_api/remote_lrs_spec.rb
 - spec/tin_can_api/result_spec.rb
 - spec/tin_can_api/score_spec.rb
 - spec/tin_can_api/statement_ref_spec.rb
@@ -225,11 +225,11 @@ test_files:
 - spec/tin_can_api/agent_account_spec.rb
 - spec/tin_can_api/agent_spec.rb
 - spec/tin_can_api/attachment_spec.rb
-- spec/tin_can_api/client_spec.rb
 - spec/tin_can_api/context_activities_spec.rb
 - spec/tin_can_api/context_spec.rb
 - spec/tin_can_api/group_spec.rb
 - spec/tin_can_api/interaction_component_spec.rb
+- spec/tin_can_api/remote_lrs_spec.rb
 - spec/tin_can_api/result_spec.rb
 - spec/tin_can_api/score_spec.rb
 - spec/tin_can_api/statement_ref_spec.rb

data/lib/tin_can_api/client.rb

@@ -1,402 +0,0 @@
-# encoding: utf-8
-require 'faraday'
-require 'addressable/uri'
-require 'tin_can_api/tcapi_version'
-module TinCanApi
-  # Class used to communicate with a TCAPI endpoint synchronously
-  class Client
-    include TinCanApi::TCAPIVersion
-
-    VALID_PARAMS = %w(end_point user_name password version)
-
-    attr_accessor :end_point, :user_name, :password, :version
-
-    def initialize(options={}, &block)
-      setup_options(options)
-      yield_or_eval(&block) if block_given?
-      @version ||= latest_version
-    end
-
-    def about
-      response = connection.get("#{path}about")
-      LrsResponse.new do |lrs|
-        lrs.status = response.status
-        if response.status== 200
-          lrs.content = About.new(json: response.body)
-          lrs.success = true
-        else
-          lrs.success = false
-        end
-      end
-    end
-
-    def save_statement(statement)
-      # TODO: Complete this
-      if statement.id
-        response = connection.put do |req|
-          req.url("#{path}statements")
-          req.headers['Content-Type'] = 'application/json'
-          req.params.merge!({'statementId' => statement.id})
-          req.body = statement.serialize(latest_version).to_json
-        end
-      else
-        response = connection.post do |req|
-          req.url("#{path}statements")
-          req.headers['Content-Type'] = 'application/json'
-          req.body = statement.serialize(latest_version).to_json
-        end
-      end
-      LrsResponse.new do |lrs|
-        lrs.status = response.status
-        lrs.content = statement
-        if response.status == 200
-          statement.id = JSON.parse(response.body).first
-          lrs.success = true
-        elsif response.status == 204
-          lrs.success = true
-        else
-          lrs.success = false
-        end
-      end
-    end
-
-    def save_statements(statements)
-      # TODO: Complete this
-      if statements.empty?
-        return LrsResponse.new do |lrs|
-          lrs.success = true
-        end
-      end
-      response = connection.post do |req|
-        req.url("#{path}statements")
-        req.headers['Content-Type'] = 'application/json'
-        req.body = statements.map {|s| s.serialize(latest_version)}.to_json
-      end
-      LrsResponse.new do |lrs|
-        lrs.status = response.status
-        if response.status == 200
-          lrs.content = statements
-          ids = JSON.parse(response.body)
-          statements.each_with_index do |statement, index|
-            statement.id = ids[index]
-          end
-          lrs.success = true
-        else
-          lrs.success = false
-        end
-      end
-    end
-
-    def retrieve_statement(id)
-      get_statement(id, 'statementId')
-    end
-
-    def retrieve_voided_statement(id)
-      param_name = version == TCAPIVersion.V095 ? 'statementId' : 'voidedStatementId'
-      get_statement(id, param_name)
-    end
-
-    def query_statements(statement_query)
-      # TODO: Complete this
-      query = statement_query
-      unless query
-        query = version == TCAPIVersion::V095 ? StatementsQueryV095.new : StatementsQuery.new
-      end
-      # Error if the query parameters don't match the LRS version
-      raise Errors::IncompatibleTCAPIVersion, "Attempted to issue #{version} query using a #{query.version} set of query parameters." unless version == query.version
-
-      response = connection.get do |req|
-        req.url("#{path}statements")
-        req.params.merge!(query.parameter_map)
-      end
-      LrsResponse.new do |lrs|
-        lrs.status = response.status
-        if response.status == 200
-          # TODO: FIX THIS
-          lrs.success = true
-          lrs.content = StatementsResult.new(json: response.body)
-        else
-          lrs.success = false
-        end
-      end
-    end
-
-    def more_statements(more_url)
-      # TODO: Complete this
-      # more_url is relative to the endpoint's server root
-      response = connection.get do |req|
-        req.url("#{path}#{more_url}")
-      end
-      LrsResponse.new do |lrs|
-        lrs.status = response.status
-        if response.status == 200
-          # TODO: FIX THIS
-          lrs.success = true
-          lrs.content = StatementsResult.new(json: response.body)
-        else
-          lrs.success = false
-        end
-      end
-    end
-
-    def retrieve_state_ids(activity, agent, registration)
-      # TODO: Complete this
-      query_params = {
-          'activityId' =>  activity.id,
-          'agent' => agent.serialize(version).to_json
-      }
-      query_params['registration'] = registration if registration
-      get_profile_keys('activities/state', query_params)
-    end
-
-    def retrieve_state(id, activity, agent, registration)
-      # TODO: Complete this
-      query_params = {
-          'stateId' => id,
-          'activityId' => activity.id,
-          'agent' => agent.serialize(version).to_json
-      }
-      document = StateDocument.new do |sd|
-        sd.id = id
-        sd.activity = activity
-        sd.agent = agent
-      end
-      lrs_response = get_document('activities/state', query_params, document)
-      if lrs_response.status == 200
-        lrs_response.content = document
-      end
-      lrs_response
-    end
-
-    def save_state(state)
-      # TODO: Complete this
-      query_params = {
-          'stateId' => state.id,
-          'activityId' => state.activity.id,
-          'agent' => state.agent.serialize(version).to_json
-      }
-      save_document('activities/state', query_params, state)
-    end
-
-    def delete_state(state)
-      # TODO: Complete this
-      query_params = {
-          'stateId' => state.id,
-          'activityId' => state.activity.id,
-          'agent' => state.agent.serialize(version).to_json
-      }
-      query_params['registration'] = state.registration if state.registration
-      delete_document('activities/state', query_params)
-    end
-
-    def clear_state(activity, agent, registration)
-      # TODO: Complete this
-      query_params = {
-          'activityId' => activity.id,
-          'agent' => agent.serialize(version).to_json
-      }
-      query_params['registration'] = registration if registration
-      delete_document('activities/state', query_params)
-    end
-
-    def retrieve_activity_profile_ids(activity)
-      # TODO: Complete this
-      query_params = {
-          'activityId' => activity.id
-      }
-      get_profile_keys('activities/profile', query_params)
-    end
-
-    def retrieve_activity_profile(id, activity)
-      # TODO: Complete this
-      query_params = {
-          'profileId' => id,
-          'activityId' => activity.id,
-      }
-      document = ActivityProfileDocument.new do |apd|
-        apd.id = id
-        apd.activity = activity
-      end
-      lrs_response = get_document('activities/profile', query_params, document)
-      if lrs_response.status == 200
-        lrs_response.content = document
-      end
-      lrs_response
-    end
-
-    def save_activity_profile(profile)
-      # TODO: Complete this
-      query_params = {
-          'profileId' => profile.id,
-          'activityId' => profile.activity.id,
-      }
-      save_document('activities/profile', query_params, profile)
-    end
-
-    def delete_activity_profile(profile)
-      # TODO: Complete this
-      query_params = {
-          'profileId' => profile.id,
-          'activityId' => profile.activity.id,
-      }
-      delete_document('activities/profile', query_params)
-    end
-
-    def retrieve_agent_profile_ids(agent)
-      # TODO: Complete this
-      query_params = {
-          'agent' => agent.serialize(version).to_json
-      }
-      get_profile_keys('agents/profile', query_params)
-    end
-
-    def retrieve_agent_profile(id, agent)
-      # TODO: Complete this
-      query_params = {
-          'profileId' => id,
-          'agent' => agent.serialize(version).to_json
-      }
-      document = AgentProfileDocument.new do |apd|
-        apd.id = id
-        apd.agent = agent
-      end
-      lrs_response = get_document('agents/profile', query_params, document)
-      if lrs_response.status == 200
-        lrs_response.content = document
-      end
-      lrs_response
-    end
-
-    def save_agent_profile(profile)
-      # TODO: Complete this
-      query_params = {
-          'profileId' => profile.id,
-          'agent' => profile.agent.serialize(version).to_json
-      }
-      save_document('agents/profile', query_params, profile)
-    end
-
-    def delete_agent_profile(profile)
-      # TODO: Complete this
-      query_params = {
-          'profileId' => profile.id,
-          'agent' => profile.agent.serialize(version).to_json
-      }
-      delete_document('agents/profile', query_params)
-    end
-
-    private
-
-    def setup_options(options={})
-      options.each_pair do |key, value|
-        if value && VALID_PARAMS.include?(key.to_s)
-          instance_variable_set("@#{key}", value)
-        end
-      end
-    end
-
-    def yield_or_eval(&block)
-      return unless block
-      block.arity < 1 ? instance_eval(&block) : block[self]
-    end
-
-    def uri
-      @uri ||= Addressable::URI.parse(end_point)
-    end
-
-    def path
-      @path ||= uri.path
-      @path += '/' unless @path.end_with?('/')
-      @path
-    end
-
-    def connection
-      base_url = "#{uri.scheme}://#{uri.host}"
-      base_url = "#{base_url}:#{uri.port}" if uri.port
-      @connection ||= Faraday.new(:url => base_url) do |faraday|
-        faraday.request  :url_encoded             # form-encode POST params
-        faraday.response :logger                  # log requests to STDOUT
-        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
-        faraday.headers['X-Experience-API-Version'] = version.to_s
-        faraday.basic_auth(user_name, password)
-      end
-    end
-
-    def get_statement(id, parameter)
-      response = connection.get do |req|
-        req.url("#{path}statements")
-        req.headers['Content-Type'] = 'application/json'
-        req.params.merge!({parameter => id})
-      end
-      LrsResponse.new do |lrs|
-        lrs.status = response.status
-        if response.status== 200
-          lrs.content = Statement.new(json: response.body)
-          lrs.success = true
-        else
-          lrs.success = false
-        end
-      end
-    end
-
-    def get_document(resource, params, document)
-      response = connection.get do |req|
-        req.url("#{path}#{resource}")
-        req.params.merge!(params)
-      end
-      LrsResponse.new do |lrs|
-        lrs.status = response.status
-        if response.status == 200
-          lrs.success = true
-          # TODO FIX THIS
-        elsif response.status == 404
-          lrs.success = true
-        else
-          lrs.success = false
-        end
-      end
-    end
-
-    def delete_document(resource, params)
-      response = connection.delete do |req|
-        req.url("#{path}#{resource}")
-        req.params.merge!(params)
-      end
-      LrsResponse.new do |lrs|
-        lrs.status = response.status
-        if response.status == 204
-          lrs.success = true
-        else
-          lrs.success = false
-        end
-      end
-    end
-
-    def save_document(resource, params, document)
-      # TODO: Complete this
-      response = connection.put do |req|
-        req.url("#{path}#{resource}")
-        req.headers['Content-Type'] = 'application/json'
-        req.headers['If-Match'] = document.etag if document.etag
-        req.params.merge!(params)
-        req.body = document.content
-      end
-      LrsResponse.new do |lrs|
-        lrs.status = response.status
-        if response.status == 204
-          lrs.success = true
-        else
-          lrs.success = false
-        end
-      end
-    end
-
-    def get_profile_keys(resource, params)
-      # TODO FIX THIS
-      connection.get do |req|
-        req.url("#{path}#{resource}")
-        req.params.merge!(params)
-      end
-    end
-  end
-end