convertkit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 726a66a66a65b27bd72bfc3522a69e4d47749d62
+  data.tar.gz: 01967e6c7b5be8c969067a752f6108c1492bdf95
+SHA512:
+  metadata.gz: 73d289743b9bf788e3e4c80129957946a6b92182dbb73a0378e83df1a80aa258709021170a92ceb4b54ca647de9d2c387616c21ea03aee791be251619b0ebd97
+  data.tar.gz: afda1511792aa2dab1a87ecedc27d8d5352428081a7c27c5fa5072353e710b1b5026b8d36a908c45661213eeca59a1ac0c8603a9b724d907a45f4cedc16a40f5

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+  - ruby-head
+
+sudo: false
+
+bundler_args: --without development --retry=3 --jobs=3
+
+env:
+  global:
+    - JRUBY_OPTS="$JRUBY_OPTS --debug"
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx-2
+    - rvm: ruby-head
+  fast_finish: true

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in convertkit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Steve Corona
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Convertkit
+
+Rubygem for the excellent Converkit. Allows you to get forms, courses, and subscribe people to your mailing lists.
+
+*Only supports the v2 API*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'convertkit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install convertkit
+
+## Usage
+
+First, configure your client like so:
+
+	client = Convertkit::Client.new(key: "apikey")
+
+### Get list of forms
+
+	forms = client.forms
+
+Will give you back something like this (a ConvertKit::Form object)
+
+	#<ConvertKit::Form:0x007fc5020ae460
+ 		@client=
+  			#<ConvertKit::Client:0x007fc502846830
+   				@key="xxxx",
+   				@uri="https://api.convertkit.com",
+   				@version=2>,
+ 		@created_at="2014-12-02T14:15:47Z",
+ 		@details="https://api.convertkit.com/forms/4812558?k=xxx&v=2",
+ 		@embed="https://api.convertkit.com/forms/4812558/embed?k=xxx&v=2",
+ 		@id=481,
+ 		@name="10 days to a better gem",
+ 		@subscriber_count=4,
+ 		@updated_at="2014-12-12T13:26:14Z">
+
+## Subscribe to a form
+
+	form = client.form(4)
+	form.subscribe(email: "email@email.com", fname: "name", course_opted: true)
+
+## Form details
+
+	form = client.form(4)
+
+## Get Courses
+
+	courses = client.courses
+
+## Get Course Details
+
+	course = client.courses(4)
+
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/stevencorona/convertkit/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/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+task :default => :spec
+
+task :console do
+	exec "irb -r convertkit -I ./lib"
+end

data/convertkit.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'convertkit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "convertkit"
+  spec.version       = ConvertKit::VERSION
+  spec.authors       = ["Steve Corona"]
+  spec.email         = ["thestevecorona@gmail.com"]
+  spec.summary       = %q{Rubygem for the Convertkit API}
+  spec.description   = %q{Rubygem for the Convertkit API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.13.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/convertkit/client.rb

@@ -0,0 +1,35 @@
+require 'httparty'
+
+module ConvertKit
+
+  class Client
+    include HTTParty
+
+    attr_reader :key, :uri, :version
+
+    def initialize(key, uri="https://api.convertkit.com")
+      @key     = key
+      @uri     = uri
+      @version = 2
+    end
+
+    def form(id)
+      form = ConvertKit::Form.new(id)
+      form.client = self
+
+      form
+    end
+
+    def courses()
+
+    end
+
+    private 
+
+    def get_request(url)
+      json = self.class.get("#{@uri}/#{url}?k=#{@key}&v=#{@version}")
+      JSON.parse(json.body)
+    end
+
+  end
+end

data/lib/convertkit/course.rb

@@ -0,0 +1,7 @@
+module ConvertKit
+  class Course
+
+  	attr_reader :id, :name, :subscriber_count, :unsubscribe_count, :details, :created_at, :updated_at
+
+  end
+end

data/lib/convertkit/form.rb

@@ -0,0 +1,45 @@
+module ConvertKit
+  class Form
+
+    attr_reader :id, :subscriber_count, :name, :details, :embed, :created_at, :updated_at
+    attr_writer :client
+
+    def load(data, client)
+      @client = client
+
+      @id               = data["id"]
+      @subscriber_count = data["subscriber_count"]
+      @name             = data["name"]
+      @details          = data["details"]
+      @embed            = data["embed"]
+      @created_at       = data["created_at"]
+      @updated_at       = data["updated_at"]
+    end
+    
+    def initialize(id)
+      @id = id
+    end
+
+    def subscribe(opts)
+      default = {email: nil, fname: nil, course_opted: true}
+    end
+
+  end
+
+  class Client
+    def forms()
+      raw   = get_request("/forms")
+      forms = []
+
+      raw.each do |raw_form|
+        form = ConvertKit::Form.new(raw_form["id"])
+        form.load(raw_form, self)
+
+        forms << form
+      end
+
+      forms
+    end
+  end
+  
+end

data/lib/convertkit/version.rb

@@ -0,0 +1,3 @@
+module ConvertKit
+  VERSION = "0.0.1"
+end

data/lib/convertkit.rb

@@ -0,0 +1,8 @@
+require "convertkit/version"
+require "convertkit/client"
+require "convertkit/form"
+require "convertkit/course"
+
+module ConvertKit
+  # Your code goes here...
+end

data/spec/convertkit/client_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+module ConvertKit
+  describe Client do
+    describe "#initialize" do
+      let(:client) { ConvertKit::Client.new(123) }
+
+      it "returns a new client" do
+        expect(client).to be_a(Object)
+      end
+
+      it "saves the client id" do
+        expect(client.key).to be(123)
+      end
+
+      it "uses version 2" do
+        expect(client.version).to be(2)
+      end
+
+      it "uses the https convertkit endpoint" do
+        expect(client.uri).to eq("https://api.convertkit.com")
+      end
+
+      it "allows you to pass in the uri" do
+        expect(ConvertKit::Client.new(123, "https://api.dummy.com").uri).to eq("https://api.dummy.com")
+      end
+    end
+  end
+end

data/spec/convertkit/form_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+module ConvertKit
+  describe Form do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+require "convertkit"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.order = :random
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: convertkit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steve Corona
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: Rubygem for the Convertkit API
+email:
+- thestevecorona@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- convertkit.gemspec
+- lib/convertkit.rb
+- lib/convertkit/client.rb
+- lib/convertkit/course.rb
+- lib/convertkit/form.rb
+- lib/convertkit/version.rb
+- spec/convertkit/client_spec.rb
+- spec/convertkit/form_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rubygem for the Convertkit API
+test_files:
+- spec/convertkit/client_spec.rb
+- spec/convertkit/form_spec.rb
+- spec/spec_helper.rb