Refactor thor #47

abtris · 2014-09-15T23:22:27Z

Summary

refactor using Thor
add integration tests via Cucumber/Aruba
update tests to run RSpec 3
integration tests (at circle)

…ferences after upgrade from version 2

…ib from API_NAME.apiary.io # This is integration testing you have to set APIARY_API_KEY Scenario: Fetch apiary.apib from API_NAME.apiary.io # features/fetch.feature:4 When I run `apiary fetch --api-name apiaryclienttest` # aruba-0.6.1/lib/aruba/cucumber.rb:93 Then the output should contain the content of file "apiary.apib" # features/step_definitions/file_content_step.rb:1 Feature: Show API documentation in specified browser # This is integration testing you have to set APIARY_API_KEY Scenario: Write generated HTML into specified file # features/preview.feature:4 When I run `apiary preview --path apiary.apib --output=test.html` # aruba-0.6.1/lib/aruba/cucumber.rb:93 Then a file named "test.html" should exist # aruba-0.6.1/lib/aruba/cucumber.rb:307 Feature: Publish apiary.apib on docs.API_NAME.apiary.io # This is integration testing you have to set APIARY_API_KEY Scenario: Publish apiary.apib on docs.API_NAME.apiary.io # features/publish.feature:4 When I run `apiary publish --path=apiary.apib --api-name 1111apiaryclienttest` # aruba-0.6.1/lib/aruba/cucumber.rb:93 Then the exit status should be 1 # aruba-0.6.1/lib/aruba/cucumber.rb:197 Feature: Version of Apiary client Scenario: Print the semantic version of Apiary client # features/version.feature:3 When I run `apiary version` # aruba-0.6.1/lib/aruba/cucumber.rb:93 Then the output should match /^([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?$/ # aruba-0.6.1/lib/aruba/cucumber.rb:180 And the exit status should be 0 # aruba-0.6.1/lib/aruba/cucumber.rb:197 4 scenarios (4 passed) 9 steps (9 passed) 0m3.871s

honzajavorek · 2014-09-16T10:41:54Z

Note: If merged, closes #37.

honzajavorek · 2014-09-16T11:01:21Z

lib/apiary/cli.rb

+    desc "fetch", "Fetch apiary.apib from API_NAME.apiary.io"
+    method_option :api_name, :type => :string, :required => true, :default => ''
+    def fetch
+        cmd = Apiary::Command::Fetch.new options


Some files have indentation by two spaces, some by four - I do not like this. Please, unify it throughout the codebase.

I'll fix all to 2, thx

honzajavorek · 2014-09-16T11:08:48Z

Why Circle? Thought that we usually put OpenSource projects into TravisCI.

honzajavorek · 2014-09-16T11:09:56Z

spec/command/fetch_spec.rb

    BODY_EXAMPLE = '{
  "error": false,
  "message": "",
  "code": "FORMAT: 1A\nHOST: http://www.testing.com\n\n# Notes API test 123\nNotes API is a *short texts saving* service similar to its physical paper presence on your table.\n\n# Group Notes\nNotes related resources of the **Notes API**\n\n## Notes Collection [/notes]\n### List all Notes [GET]\n+ Response 200 (application/json)\n\n        [{\n          \"id\": 1, \"title\": \"Jogging in park\"\n        }, {\n          \"id\": 2, \"title\": \"Pick-up posters from post-office\"\n        }]\n\n### Create a Note [POST]\n+ Request (application/json)\n\n        { \"title\": \"Buy cheese and bread for breakfast.\" }\n\n+ Response 201 (application/json)\n\n        { \"id\": 3, \"title\": \"Buy cheese and bread for breakfast.\" }\n\n## Note [/notes/{id}]\nA single Note object with all its details\n\n+ Parameters\n    + id (required, number, `1`) ... Numeric `id` of the Note to perform action with. Has example value.\n\n### Retrieve a Note [GET]\n+ Response 200 (application/json)\n\n    + Header\n\n            X-My-Header: The Value\n\n    + Body\n\n            { \"id\": 2, \"title\": \"Pick-up posters from post-office\" }\n\n### Remove a Note [DELETE]\n+ Response 204\n"
-}'    


honzajavorek · 2014-09-16T11:13:30Z

Large PR :-( Please, split into smaller pieces next time so it is easier to understand and review.

As I am not that good in Ruby, I do not have balls to push the Merge button on something this big without someone else also reviewing this.

abtris · 2014-09-16T15:27:02Z

Circle for integration rake features i have to use APIARY_API_KEY for this.

abtris · 2014-09-16T15:27:45Z

Sorry for large PR, but doesn't not work without many changes.

abtris · 2014-09-27T15:23:57Z

@honzajavorek All works, please look into and merge or close.

Almad · 2014-09-27T15:42:05Z

spec/command/preview_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Apiary::Command::Preview do


Isn't this dead code?

Yes and no. It's some from future feature. I'll remove from this PR.

Refactor thor

honzajavorek · 2014-09-29T12:14:14Z

@abtris will you please publish a new version?

Almad · 2014-10-03T20:52:21Z

@abtris Would you please give access to more people like @honzajavorek so they can publish new releases as well? ;)

abtris · 2014-10-03T20:54:04Z

@Almad Hi can (5 people can).

honzajavorek · 2014-10-03T21:38:18Z

My request was not because I could not, but because I forgot again how to do it and I knew @abtris will have it done in a minute, so I kindly asked him :) I did already release apiary-client in history.

Almad · 2014-10-03T23:57:28Z

@honzajavorek this means we should have rake release or something similar (as we do have paver release)

abtris · 2014-10-04T00:02:51Z

@Almad I add into #52 it's small change

Almad · 2014-10-04T00:07:13Z

@abtris I'd still say "branch properly"...

abtris · 2014-10-04T00:14:33Z

Fixed

Ladislav Prskavec added 9 commits September 15, 2014 14:41

Thor refactor

1166222

Remove command.rb and simplify all running

15aba8c

Add dependency at rspec 3.1 and aruba

9f98d68

Add cucumber with aruba for testing scenarios. Fixed rspec 3 some dif…

0667f2c

…ferences after upgrade from version 2

Preview feature

87562a2

Publish feature

3a41508

Update fixtures

16d2587

Fix handling files

2ab3a4d

honzajavorek reviewed Sep 16, 2014
View reviewed changes

Ladislav Prskavec added 2 commits September 16, 2014 09:54

Fix indentation

f71c0ff

Remove debug part

08c37e9

abtris force-pushed the abtris/refactor-thor branch from 27dd4ef to d60bf4b Compare September 26, 2014 00:20

Add circleci config

2ab425d

abtris force-pushed the abtris/refactor-thor branch from d60bf4b to 2ab425d Compare September 26, 2014 00:20

Fix fixtures, skip unrelevant test

eec2155

Almad reviewed Sep 27, 2014
View reviewed changes

Remove ununsed test

c912791

honzajavorek added a commit that referenced this pull request Sep 29, 2014

Merge pull request #47 from apiaryio/abtris/refactor-thor

36b066d

Refactor thor

honzajavorek merged commit 36b066d into master Sep 29, 2014

honzajavorek deleted the abtris/refactor-thor branch September 29, 2014 12:13

honzajavorek mentioned this pull request Sep 29, 2014

Rewrite CLI arguments parsing with Thor #37

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor thor #47

Refactor thor #47

abtris commented Sep 15, 2014

honzajavorek commented Sep 16, 2014

honzajavorek Sep 16, 2014

abtris Sep 16, 2014

netmilk Sep 16, 2014

honzajavorek commented Sep 16, 2014

honzajavorek Sep 16, 2014

honzajavorek commented Sep 16, 2014

abtris commented Sep 16, 2014

abtris commented Sep 16, 2014

abtris commented Sep 27, 2014

Almad Sep 27, 2014

abtris Sep 27, 2014

abtris Sep 27, 2014

honzajavorek commented Sep 29, 2014

Almad commented Oct 3, 2014

abtris commented Oct 3, 2014

honzajavorek commented Oct 3, 2014

Almad commented Oct 3, 2014

abtris commented Oct 4, 2014

Almad commented Oct 4, 2014

abtris commented Oct 4, 2014

		@@ -0,0 +1,7 @@
		require 'spec_helper'

		describe Apiary::Command::Preview do

Refactor thor #47

Refactor thor #47

Conversation

abtris commented Sep 15, 2014

honzajavorek commented Sep 16, 2014

honzajavorek Sep 16, 2014

Choose a reason for hiding this comment

abtris Sep 16, 2014

Choose a reason for hiding this comment

netmilk Sep 16, 2014

Choose a reason for hiding this comment

honzajavorek commented Sep 16, 2014

honzajavorek Sep 16, 2014

Choose a reason for hiding this comment

honzajavorek commented Sep 16, 2014

abtris commented Sep 16, 2014

abtris commented Sep 16, 2014

abtris commented Sep 27, 2014

Almad Sep 27, 2014

Choose a reason for hiding this comment

abtris Sep 27, 2014

Choose a reason for hiding this comment

abtris Sep 27, 2014

Choose a reason for hiding this comment

honzajavorek commented Sep 29, 2014

Almad commented Oct 3, 2014

abtris commented Oct 3, 2014

honzajavorek commented Oct 3, 2014

Almad commented Oct 3, 2014

abtris commented Oct 4, 2014

Almad commented Oct 4, 2014

abtris commented Oct 4, 2014